|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ChildNodeEntries
ChildNodeEntries
represents a collection of NodeEntry
s that
also maintains the index values of same-name siblings on insertion and removal.
Field Summary | |
---|---|
static int |
STATUS_INVALIDATED
|
static int |
STATUS_OK
|
Method Summary | |
---|---|
void |
add(NodeEntry cne)
Adds a NodeEntry to the end of the list. |
void |
add(NodeEntry cne,
int index)
Adds a NodeEntry .Note the following special cases: If an entry with the given index already exists, the the new sibling is inserted before. If the given index is bigger that the last entry in the siblings list, intermediate entries will be created. |
void |
add(NodeEntry entry,
NodeEntry beforeEntry)
Adds a the new NodeEntry before beforeEntry . |
NodeEntry |
get(ChildInfo childInfo)
Find the matching NodeEntry for the given ChildInfo . |
List |
get(Name nodeName)
Returns a List of NodeEntry s for the
given nodeName . |
NodeEntry |
get(Name nodeName,
int index)
Returns the NodeEntry with the given
nodeName and index . |
NodeEntry |
get(Name nodeName,
String uniqueID)
Return the NodeEntry that matches the given nodeName and
uniqueID or null if no matching entry can be found. |
int |
getStatus()
Returns the status of this ChildNodeEntries object. |
Iterator |
iterator()
Returns an unmodifiable iterator over all NodeEntry objects present in this ChildNodeEntries collection irrespective of their status. |
void |
reload()
Reloads this ChildNodeEntries object. |
NodeEntry |
remove(NodeEntry childEntry)
Removes the child node entry refering to the node state. |
NodeEntry |
reorder(NodeEntry insertEntry,
NodeEntry beforeEntry)
Reorders an existing NodeEntry before another
NodeEntry . |
void |
setStatus(int status)
Mark ChildNodeEntries in order to force reloading the
entries. |
Field Detail |
---|
static final int STATUS_OK
static final int STATUS_INVALIDATED
Method Detail |
---|
int getStatus()
STATUS_OK
or STATUS_INVALIDATED
void setStatus(int status)
ChildNodeEntries
in order to force reloading the
entries.
status
- void reload() throws ItemNotFoundException, RepositoryException
ChildNodeEntries
object.
ItemNotFoundException
RepositoryException
Iterator iterator()
List get(Name nodeName)
List
of NodeEntry
s for the
given nodeName
. This method does not filter out
removed NodeEntry
s.
nodeName
- the child node name.
nodeName
.NodeEntry get(Name nodeName, int index)
NodeEntry
with the given
nodeName
and index
. Note, that this method
does not filter out removed NodeEntry
s.
nodeName
- name of the child node entry.index
- the index of the child node entry.
NodeEntry
or null
if there
is no such NodeEntry
.NodeEntry get(Name nodeName, String uniqueID)
NodeEntry
that matches the given nodeName and
uniqueID or null
if no matching entry can be found.
nodeName
- uniqueID
-
IllegalArgumentException
- if the given uniqueID is null.NodeEntry get(ChildInfo childInfo)
ChildInfo
. Returns
null
if no matching entry can be found. NOTE, that no check
for validity of the entries is made.
childInfo
-
void add(NodeEntry cne)
NodeEntry
to the end of the list. Same as
add(NodeEntry, int)
, where the index is Path.INDEX_UNDEFINED
.
cne
- the NodeEntry
to add.void add(NodeEntry cne, int index)
NodeEntry
.
cne
- the NodeEntry
to add.void add(NodeEntry entry, NodeEntry beforeEntry)
NodeEntry
before beforeEntry
.
entry
- beforeEntry
- NodeEntry remove(NodeEntry childEntry)
childEntry
- the entry to be removed.
null
if there is no such entry.NodeEntry reorder(NodeEntry insertEntry, NodeEntry beforeEntry)
NodeEntry
before another
NodeEntry
. If beforeEntry
is
null
insertEntry
is moved to the end of the
child node entries.
insertEntry
- the NodeEntry to move.beforeEntry
- the NodeEntry where insertEntry
is
reordered to.
NoSuchElementException
- if insertEntry
or
beforeEntry
does not have a NodeEntry
in this ChildNodeEntries
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |