org.opends.server.api
Class SubtreeSpecification

java.lang.Object
  extended by org.opends.server.api.SubtreeSpecification
Direct Known Subclasses:
SimpleSubtreeSpecification

@PublicAPI(stability=VOLATILE,
           mayInstantiate=false,
           mayExtend=true,
           mayInvoke=false)
public abstract class SubtreeSpecification
extends java.lang.Object

Generic subtree specification interface.


Constructor Summary
protected SubtreeSpecification()
          Create a new subtree specification.
 
Method Summary
abstract  boolean equals(java.lang.Object obj)
          Indicates whether the provided object is logically equal to this subtree specification object.
abstract  int hashCode()
          Retrieves the hash code for this subtree specification object.
abstract  boolean isWithinScope(Entry entry)
          Determine if an entry is within the scope of the subtree specification.
 java.lang.String toString()
          Retrieves a string representation of this subtree specification object.
abstract  java.lang.StringBuilder toString(java.lang.StringBuilder builder)
          Append the string representation of the subtree specification to the provided string builder.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SubtreeSpecification

protected SubtreeSpecification()
Create a new subtree specification.

Method Detail

isWithinScope

public abstract boolean isWithinScope(Entry entry)
Determine if an entry is within the scope of the subtree specification.

Parameters:
entry - The entry.
Returns:
true if the entry is within the scope of the subtree specification, or false if not.

equals

public abstract boolean equals(java.lang.Object obj)
Indicates whether the provided object is logically equal to this subtree specification object.

Overrides:
equals in class java.lang.Object
Parameters:
obj - The object for which to make the determination.
Returns:
true if the provided object is logically equal to this subtree specification object, or false if not.

hashCode

public abstract int hashCode()
Retrieves the hash code for this subtree specification object.

Overrides:
hashCode in class java.lang.Object
Returns:
The hash code for this subtree specification object.

toString

public abstract java.lang.StringBuilder toString(java.lang.StringBuilder builder)
Append the string representation of the subtree specification to the provided string builder.

Parameters:
builder - The string builder.
Returns:
The string builder.

toString

public final java.lang.String toString()
Retrieves a string representation of this subtree specification object.

Overrides:
toString in class java.lang.Object
Returns:
A string representation of this subtree specification object.