|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.AbstractCollection<E>
java.util.AbstractSet<SubtreeSpecification>
org.opends.server.api.SubtreeSpecificationSet
@PublicAPI(stability=VOLATILE, mayInstantiate=true, mayExtend=false, mayInvoke=true) public final class SubtreeSpecificationSet
This class implements the Set
interface for
SubtreeSpecification
s.
It is backed by a HashSet
but provides additional
functionality, isWithinScope(Entry)
, for determining
whether or not an entry is within the scope of one or more
contained SubtreeSpecification
s.
Constructor Summary | |
---|---|
SubtreeSpecificationSet()
Constructs a new empty subtree specification set. |
|
SubtreeSpecificationSet(java.util.Collection<? extends SubtreeSpecification> c)
Constructs a new subtree specification set containing the elements in the specified collection. |
Method Summary | |
---|---|
boolean |
add(SubtreeSpecification e)
Adds the provided subtree specification object to this set. |
boolean |
contains(java.lang.Object o)
Indicates whether this set contains the provided object. |
boolean |
isWithinScope(Entry entry)
Returns true if the specified entry is within the scope
of a subtree specifications contained in the set. |
java.util.Iterator<SubtreeSpecification> |
iterator()
Retrieves an iterator that may be used to step through the values in this set. |
int |
size()
Retrieves the number of elements contained in this set. |
Methods inherited from class java.util.AbstractSet |
---|
equals, hashCode, removeAll |
Methods inherited from class java.util.AbstractCollection |
---|
addAll, clear, containsAll, isEmpty, remove, retainAll, toArray, toArray, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.util.Set |
---|
addAll, clear, containsAll, isEmpty, remove, retainAll, toArray, toArray |
Constructor Detail |
---|
public SubtreeSpecificationSet()
public SubtreeSpecificationSet(java.util.Collection<? extends SubtreeSpecification> c)
c
- The subtree specification collection whose elements
are to be placed into this set.Method Detail |
---|
public boolean isWithinScope(Entry entry)
true
if the specified entry is within the scope
of a subtree specifications contained in the set.
entry
- The entry to be checked for containment.
true
if the set contains the specified
entry.public boolean add(SubtreeSpecification e)
add
in interface java.util.Collection<SubtreeSpecification>
add
in interface java.util.Set<SubtreeSpecification>
add
in class java.util.AbstractCollection<SubtreeSpecification>
e
- The subtree specification object to be added.
true
if the element was added to the set, or
false
if the element was already contained in
the set.public java.util.Iterator<SubtreeSpecification> iterator()
iterator
in interface java.lang.Iterable<SubtreeSpecification>
iterator
in interface java.util.Collection<SubtreeSpecification>
iterator
in interface java.util.Set<SubtreeSpecification>
iterator
in class java.util.AbstractCollection<SubtreeSpecification>
public boolean contains(java.lang.Object o)
contains
in interface java.util.Collection<SubtreeSpecification>
contains
in interface java.util.Set<SubtreeSpecification>
contains
in class java.util.AbstractCollection<SubtreeSpecification>
o
- The object for which to make the determination.
true
if this set contains the provided object,
or false
if not.public int size()
size
in interface java.util.Collection<SubtreeSpecification>
size
in interface java.util.Set<SubtreeSpecification>
size
in class java.util.AbstractCollection<SubtreeSpecification>
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |