|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jboss.dna.graph.requests.Request org.jboss.dna.graph.requests.CacheableRequest org.jboss.dna.graph.requests.ReadPropertyRequest
public class ReadPropertyRequest
Instruction to read a single property on the node at the specified location.
Constructor Summary | |
---|---|
ReadPropertyRequest(Location on,
Name propertyName)
Create a request to read the properties and number of children of a node at the supplied location. |
Method Summary | |
---|---|
boolean |
equals(Object obj)
|
Location |
getActualLocationOfNode()
Get the actual location of the node whose property was read. |
Property |
getProperty()
Get the property that was read. |
boolean |
isReadOnly()
Return whether this request only reads information. |
Name |
named()
Get the name of the property that is to be read |
Location |
on()
Get the location defining the node that is to be read. |
void |
setActualLocationOfNode(Location actual)
Sets the actual and complete location of the node whose property has been read. |
void |
setProperty(Property property)
Set the property on the node as read from the RepositoryConnection |
String |
toString()
|
Methods inherited from class org.jboss.dna.graph.requests.CacheableRequest |
---|
getCachePolicy, getTimeLoaded, setCachePolicy, setTimeLoaded |
Methods inherited from class org.jboss.dna.graph.requests.Request |
---|
cancel, getError, hasError, isCancelled, setError |
Methods inherited from class java.lang.Object |
---|
getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ReadPropertyRequest(Location on, Name propertyName)
on
- the location of the node to be readpropertyName
- the name of the property to read
IllegalArgumentException
- if the location or property name are nullMethod Detail |
---|
public boolean isReadOnly()
isReadOnly
in class Request
Request.isReadOnly()
public Location on()
public Name named()
public Property getProperty()
public void setProperty(Property property)
RepositoryConnection
property
- the property that was read
IllegalArgumentException
- if the property's name does not match the name of the property
that was
to be readpublic 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 |