Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.pqt.autorib.util
Class OmitRec  view OmitRec download OmitRec.java

java.lang.Object
  extended byorg.pqt.autorib.util.OmitRec

public class OmitRec
extends java.lang.Object

This class handles wildcard strings used by the Omit statement to decide whether to include an object in a scene


Field Summary
protected  boolean isOmit
           
protected  java.lang.String name
           
 
Constructor Summary
OmitRec()
          Creates a new instance of OmitRec
OmitRec(java.lang.String name, boolean isOmit)
          Create an OmitRec with a given name and isOmit
 
Method Summary
static void addOmitsFromVector(java.util.Vector stringVector, java.util.Vector omitVector, boolean isOmit)
          A utility function to add an vector of Strings to another vector as Omit Records.
 boolean equals(java.lang.Object o)
          Determine whether this Object is semantically equal to another Object.
 boolean omit(java.lang.String name, boolean currentlyOmit)
          Check a name against this OmitRec to see if it should be omitted
 java.lang.String toString()
          Convert this Object to a human-readable String.
static boolean vectorOmit(java.util.Vector omitVector, java.lang.String name, boolean currentlyOmit)
          A utility function to check a vector of OmitRecs against a given name
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

name

protected java.lang.String name

isOmit

protected boolean isOmit
Constructor Detail

OmitRec

public OmitRec()
Creates a new instance of OmitRec


OmitRec

public OmitRec(java.lang.String name,
               boolean isOmit)
Create an OmitRec with a given name and isOmit

Method Detail

omit

public boolean omit(java.lang.String name,
                    boolean currentlyOmit)
Check a name against this OmitRec to see if it should be omitted


vectorOmit

public static boolean vectorOmit(java.util.Vector omitVector,
                                 java.lang.String name,
                                 boolean currentlyOmit)
A utility function to check a vector of OmitRecs against a given name


addOmitsFromVector

public static void addOmitsFromVector(java.util.Vector stringVector,
                                      java.util.Vector omitVector,
                                      boolean isOmit)
A utility function to add an vector of Strings to another vector as Omit Records.


toString

public java.lang.String toString()
Description copied from class: java.lang.Object
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).


equals

public boolean equals(java.lang.Object o)
Description copied from class: java.lang.Object
Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

  • It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
  • It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
  • It must be reflexive. a.equals(a) must always be true.
  • It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
  • a.equals(null) must be false.
  • It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a java.lang.ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a java.lang.NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, java.util.IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.