|
|||||||||
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.AbsoluteSubtreeSpecification
public final class AbsoluteSubtreeSpecification
An absolute subtree specification.
Absolute subtree specifications are based on RFC 3672 subtree specifications but have the following differences:
The string representation of an absolute subtree specification is defined by the following grammar:
SubtreeSpecification = "{" sp ss-absolute-base [ sep sp ss-specificExclusions ] [ sep sp ss-minimum ] [ sep sp ss-maximum ] [ sep sp ss-specificationFilter ] sp "}" ss-absolute-base = "absoluteBase" msp DistinguishedName ss-specificExclusions = "specificExclusions" msp SpecificExclusions ss-minimum = "minimum" msp BaseDistance ss-maximum = "maximum" msp BaseDistance ss-specificationFilter = "specificationFilter" msp Filter SpecificExclusions = "{" [ sp SpecificExclusion ( "," sp SpecificExclusion ) ] sp "}" SpecificExclusion = chopBefore / chopAfter chopBefore = "chopBefore" ":" LocalName chopAfter = "chopAfter" ":" LocalName Filter = dquote *SafeUTF8Character dquote
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.opends.server.core.SimpleSubtreeSpecification |
---|
SimpleSubtreeSpecification.Parser |
Constructor Summary | |
---|---|
AbsoluteSubtreeSpecification(DN absoluteBaseDN,
int minimumDepth,
int maximumDepth,
java.lang.Iterable<DN> chopBefore,
java.lang.Iterable<DN> chopAfter,
SearchFilter filter)
Create a new absolute subtree specification. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object obj)
Indicates whether the provided object is logically equal to this subtree specification object. |
DN |
getAbsoluteBaseDN()
Get the absolute base DN. |
SearchFilter |
getFilter()
Get the specification filter. |
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 AbsoluteSubtreeSpecification |
valueOf(java.lang.String s)
Parses the string argument as an absolute 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 AbsoluteSubtreeSpecification(DN absoluteBaseDN, int minimumDepth, int maximumDepth, java.lang.Iterable<DN> chopBefore, java.lang.Iterable<DN> chopAfter, SearchFilter filter)
absoluteBaseDN
- The absolute base DN of the subtree.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 base
DN), or null
if there are none.chopAfter
- The set of chop after local names (relative to the base
DN), or null
if there are none.filter
- The optional search filter (null
if there
is no filter).Method Detail |
---|
public static AbsoluteSubtreeSpecification valueOf(java.lang.String s) throws DirectoryException
The parser is very lenient regarding the ordering of the various subtree specification fields. However, it will not except multiple occurrances of a particular field.
s
- The string to be parsed.
DirectoryException
- If the string does not contain a parsable absolute
subtree specification.public DN getAbsoluteBaseDN()
public SearchFilter getFilter()
null
if there
is no filter.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 |