Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> vrspace >> server >> [ filter overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.vrspace.server.filter
Class VRObjectFilter  

java.lang.Object
  org.vrspace.server.filter.VRObjectFilter

All Implemented Interfaces:

org.vrspace.attributes.ObjectFilter

Direct Known Subclasses:

ActiveClientFilter, AdminFilter, ClassFilter, SubclassFilter

---

public abstract class VRObjectFilter

extends java.lang.Object

implements org.vrspace.attributes.ObjectFilter

VRObject filters are used to eliminate objects not needed in the scene.
In order to allow the scene to add and remove filters properly, filters must implement equals() method.
I.e. ActiveClientFilter returns true if Client.isActive() returns true. Thus, each instance of this filter is equal to any other - performs same operation.

---

Constructor Summary

VRObjectFilter()

 

Method Summary
abstract  boolean	equals(java.lang.Object o)           Determine whether this Object is semantically equal to another Object.
org.vrspace.server.VRObject	process(org.vrspace.server.VRObject o)           This is called immediatelly after testVRObject returned true. This allows to client to see another object instead - i.e.
boolean	test(java.lang.Object o)
abstract  boolean	testVRObject(org.vrspace.server.VRObject o, org.vrspace.server.Client c)           Return true if this client should see the object
java.lang.String	toString()           Convert this Object to a human-readable String.

 

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Constructor Detail

VRObjectFilter

public VRObjectFilter()

Method Detail

test

public boolean test(java.lang.Object o)

Specified by:

test in interface org.vrspace.attributes.ObjectFilter

---

testVRObject

public abstract boolean testVRObject(org.vrspace.server.VRObject o,
                                     org.vrspace.server.Client c)

Return true if this client should see the object

---

equals

public abstract 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.

---

process

public org.vrspace.server.VRObject process(org.vrspace.server.VRObject o)

This is called immediatelly after testVRObject returned true.
This allows to client to see another object instead - i.e. url rewriting.
Default - return the same object
Note: filters are chained. That is, one filter can change the object, and other filters in chain will test changed object.

---

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()).

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> vrspace >> server >> [ filter overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---