|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jboss.dna.graph.request.Request org.jboss.dna.graph.request.CacheableRequest org.jboss.dna.graph.request.ReadAllChildrenRequest
public class ReadAllChildrenRequest
Instruction to read all of the children of a node at a specific location.
Constructor Summary | |
---|---|
ReadAllChildrenRequest(Location of,
String workspaceName)
Create a request to read the children of a node at the supplied location in the designated workspace. |
Method Summary | |
---|---|
void |
addChild(Location child)
Add to the list of children that has been read the child with the given path and identification properties. |
void |
addChild(Path pathToChild,
Property idProperty)
Add to the list of children that has been read the child with the given path and identification property. |
void |
addChild(Path pathToChild,
Property firstIdProperty,
Property... remainingIdProperties)
Add to the list of children that has been read the child with the given path and identification properties. |
boolean |
equals(Object obj)
|
Location |
getActualLocationOfNode()
Get the actual location of the node whose children were read. |
List<Location> |
getChildren()
Get the children that were read from the RepositoryConnection after the request was processed. |
String |
inWorkspace()
Get the name of the workspace in which the parent and children exist. |
boolean |
isReadOnly()
Return whether this request only reads information. |
Iterator<Location> |
iterator()
|
Location |
of()
Get the location defining the node whose children are to be read. |
void |
setActualLocationOfNode(Location actualLocation)
Sets the actual and complete location of the node whose children have been read. |
String |
toString()
|
Methods inherited from class org.jboss.dna.graph.request.CacheableRequest |
---|
getCachePolicy, getTimeLoaded, setCachePolicy, setTimeLoaded |
Methods inherited from class org.jboss.dna.graph.request.Request |
---|
cancel, getError, hasError, isCancelled, setError |
Methods inherited from class java.lang.Object |
---|
getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ReadAllChildrenRequest(Location of, String workspaceName)
of
- the location of the node whose children are to be readworkspaceName
- the name of the workspace
IllegalArgumentException
- if the location or workspace name is nullMethod Detail |
---|
public boolean isReadOnly()
isReadOnly
in class Request
Request.isReadOnly()
public Location of()
public String inWorkspace()
public List<Location> getChildren()
RepositoryConnection
after the request was processed. Each child is
represented by a location.
public Iterator<Location> iterator()
iterator
in interface Iterable<Location>
Iterable.iterator()
public void addChild(Location child)
child
- the location of the child that was read
IllegalArgumentException
- if the location is nulladdChild(Path, Property)
,
addChild(Path, Property, Property...)
public void addChild(Path pathToChild, Property firstIdProperty, Property... remainingIdProperties)
pathToChild
- the path of the child that was just readfirstIdProperty
- the first identification property of the child that was just readremainingIdProperties
- the remaining identification properties of the child that was just read
IllegalArgumentException
- if the path or identification properties are nulladdChild(Location)
,
addChild(Path, Property)
public void addChild(Path pathToChild, Property idProperty)
pathToChild
- the path of the child that was just readidProperty
- the identification property of the child that was just read
IllegalArgumentException
- if the path or identification properties are nulladdChild(Location)
,
addChild(Path, Property, Property...)
public void setActualLocationOfNode(Location actualLocation)
path
.
actualLocation
- the actual location of the node being read, or null if the current location
should be
used
IllegalArgumentException
- if the actual location does not represent the same
location
as the current location
; if the actual location does not have a path; or if the actual
workspace name is nullpublic Location getActualLocationOfNode()
public boolean equals(Object obj)
equals
in class Object
Object.equals(java.lang.Object)
public String toString()
toString
in class Object
Object.toString()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |