|
|||||||||
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.ReadAllPropertiesRequest
public class ReadAllPropertiesRequest
Instruction to read the properties and the number of children of the node at the specifed location.
Field Summary | |
---|---|
static int |
UNKNOWN_NUMBER_OF_CHILDREN
|
Constructor Summary | |
---|---|
ReadAllPropertiesRequest(Location at,
String workspaceName)
Create a request to read the properties and number of children of a node at the supplied location. |
Method Summary | |
---|---|
void |
addProperties(Property... properties)
Add a property that was read from the RepositoryConnection |
Property |
addProperty(Property property)
Add a property that was read from the RepositoryConnection |
Location |
at()
Get the location defining the node that is to be read. |
boolean |
equals(Object obj)
|
Location |
getActualLocationOfNode()
Get the actual location of the node whose properties were read. |
int |
getNumberOfChildren()
Get the number of children for this node. |
Collection<Property> |
getProperties()
Get the properties that were read from the RepositoryConnection . |
Map<Name,Property> |
getPropertiesByName()
Get the properties that were read from the RepositoryConnection . |
String |
inWorkspace()
Get the name of the workspace in which the node exists. |
boolean |
isReadOnly()
Return whether this request only reads information. |
Iterator<Property> |
iterator()
|
void |
setActualLocationOfNode(Location actual)
Sets the actual and complete location of the node whose properties have been read. |
void |
setNumberOfChildren(int numberOfChildren)
Set the number of children for this node |
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 |
Field Detail |
---|
public static final int UNKNOWN_NUMBER_OF_CHILDREN
Constructor Detail |
---|
public ReadAllPropertiesRequest(Location at, String workspaceName)
at
- the location of the node to be readworkspaceName
- the name of the workspace containing the node
IllegalArgumentException
- if the location or workspace name is nullMethod Detail |
---|
public boolean isReadOnly()
isReadOnly
in class Request
Request.isReadOnly()
public Location at()
public String inWorkspace()
public Map<Name,Property> getPropertiesByName()
RepositoryConnection
.
public Collection<Property> getProperties()
RepositoryConnection
.
public Iterator<Property> iterator()
iterator
in interface Iterable<Property>
Iterable.iterator()
public Property addProperty(Property property)
RepositoryConnection
property
- the property that was read
IllegalArgumentException
- if the property is nullpublic void addProperties(Property... properties)
RepositoryConnection
properties
- the properties that were read
IllegalArgumentException
- if the property is nullpublic int getNumberOfChildren()
UNKNOWN_NUMBER_OF_CHILDREN
if the number of children was not yet readpublic void setNumberOfChildren(int numberOfChildren)
numberOfChildren
- the number of children
IllegalArgumentException
- if the number of childre is negativepublic void setActualLocationOfNode(Location actual)
path
.
actual
- 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
, or if the actual location does not have a path.public 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 |