|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.SubtreeSpecification
org.opends.server.core.SimpleSubtreeSpecification
org.opends.server.core.RFC3672SubtreeSpecification
public final class RFC3672SubtreeSpecification
An RFC 3672 subtree specification.
Refer to RFC 3672 for a detailed definition of the subtree specification string representation.
Nested Class Summary | |
---|---|
static class |
RFC3672SubtreeSpecification.AndRefinement
RFC 3672 subtree specification AND refinement. |
static class |
RFC3672SubtreeSpecification.ItemRefinement
RFC 3672 subtree specification Item refinement. |
static class |
RFC3672SubtreeSpecification.NotRefinement
RFC 3672 subtree specification NOT refinement. |
static class |
RFC3672SubtreeSpecification.OrRefinement
RFC 3672 subtree specification OR refinement. |
static class |
RFC3672SubtreeSpecification.Refinement
Abstract interface for RFC3672 specification filter refinements. |
Nested classes/interfaces inherited from class org.opends.server.core.SimpleSubtreeSpecification |
---|
SimpleSubtreeSpecification.Parser |
Constructor Summary | |
---|---|
RFC3672SubtreeSpecification(DN rootDN,
DN relativeBaseDN,
int minimumDepth,
int maximumDepth,
java.lang.Iterable<DN> chopBefore,
java.lang.Iterable<DN> chopAfter,
RFC3672SubtreeSpecification.Refinement refinements)
Create a new RFC3672 subtree specification. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object obj)
Indicates whether the provided object is logically equal to this subtree specification object. |
RFC3672SubtreeSpecification.Refinement |
getRefinements()
Get the specification filter refinements. |
DN |
getRelativeBaseDN()
Get the relative base DN. |
DN |
getRootDN()
Get the root DN. |
int |
hashCode()
Retrieves the hash code for this subtree specification object. |
boolean |
isWithinScope(Entry entry)
Determine if an entry is within the scope of the subtree specification. |
java.lang.StringBuilder |
toString(java.lang.StringBuilder builder)
Append the string representation of the subtree specification to the provided string builder. |
static RFC3672SubtreeSpecification |
valueOf(DN rootDN,
java.lang.String s)
Parses the string argument as an RFC3672 subtree specification. |
Methods inherited from class org.opends.server.core.SimpleSubtreeSpecification |
---|
commonComponentsEquals, commonComponentsHashCode, getBaseDN, getChopAfter, getChopBefore, getMaximumDepth, getMinimumDepth, isDNWithinScope |
Methods inherited from class org.opends.server.api.SubtreeSpecification |
---|
toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public RFC3672SubtreeSpecification(DN rootDN, DN relativeBaseDN, int minimumDepth, int maximumDepth, java.lang.Iterable<DN> chopBefore, java.lang.Iterable<DN> chopAfter, RFC3672SubtreeSpecification.Refinement refinements)
rootDN
- The root DN of the subtree.relativeBaseDN
- The relative base DN (or null
if not
specified).minimumDepth
- The minimum depth (<=0 means unlimited).maximumDepth
- The maximum depth (<0 means unlimited).chopBefore
- The set of chop before local names (relative to the
relative base DN), or null
if there are
none.chopAfter
- The set of chop after local names (relative to the
relative base DN), or null
if there are
none.refinements
- The optional specification filter refinements, or
null
if there are none.Method Detail |
---|
public static RFC3672SubtreeSpecification valueOf(DN rootDN, java.lang.String s) throws DirectoryException
rootDN
- The DN of the subtree specification's base entry.s
- The string to be parsed.
DirectoryException
- If the string does not contain a parsable relative
subtree specification.public DN getRootDN()
public DN getRelativeBaseDN()
null
if none
was specified.public RFC3672SubtreeSpecification.Refinement getRefinements()
null
if none were specified.public boolean isWithinScope(Entry entry)
isWithinScope
in class SubtreeSpecification
entry
- The entry.
true
if the entry is within the scope of the
subtree specification, or false
if not.public java.lang.StringBuilder toString(java.lang.StringBuilder builder)
toString
in class SubtreeSpecification
builder
- The string builder.
public boolean equals(java.lang.Object obj)
equals
in class SubtreeSpecification
obj
- The object for which to make the determination.
true
if the provided object is logically equal
to this subtree specification object, or false
if not.public int hashCode()
hashCode
in class SubtreeSpecification
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |