|
|||||||||
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.UpdatePropertiesRequest
public class UpdatePropertiesRequest
Instruction to update the properties on the node at the specified location. Any property with no values will be removed.
Constructor Summary | |
---|---|
UpdatePropertiesRequest(Location on,
Iterable<Property> properties)
Create a request to update the properties on the node at the supplied location. |
|
UpdatePropertiesRequest(Location on,
Iterator<Property> properties)
Create a request to update the properties on the node at the supplied location. |
|
UpdatePropertiesRequest(Location on,
Property... properties)
Create a request to update the properties on the node at the supplied location. |
Method Summary | |
---|---|
boolean |
equals(Object obj)
|
Location |
getActualLocationOfNode()
Get the actual location of the node that was updated. |
boolean |
isReadOnly()
Return whether this request only reads information. |
Iterator<Property> |
iterator()
|
Location |
on()
Get the location defining the node that is to be updated. |
Collection<Property> |
properties()
Get the properties for the node. |
void |
setActualLocationOfNode(Location actual)
Sets the actual and complete location of the node being updated. |
String |
toString()
|
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 UpdatePropertiesRequest(Location on, Property... properties)
on
- the location of the node to be readproperties
- the new properties on the node
IllegalArgumentException
- if the location is null or if there are no properties to updatepublic UpdatePropertiesRequest(Location on, Iterable<Property> properties)
on
- the location of the node to be readproperties
- the new properties on the node
IllegalArgumentException
- if the location is null or if there are no properties to updatepublic UpdatePropertiesRequest(Location on, Iterator<Property> properties)
on
- the location of the node to be readproperties
- the new properties on the node
IllegalArgumentException
- if the location is null or if there are no properties to updateMethod Detail |
---|
public boolean isReadOnly()
isReadOnly
in class Request
Request.isReadOnly()
public Location on()
public Iterator<Property> iterator()
iterator
in interface Iterable<Property>
Iterable.iterator()
public Collection<Property> properties()
public void setActualLocationOfNode(Location actual)
path
.
actual
- the actual location of the node being updated, or null if the current location
should be used
IllegalArgumentException
- if the actual location does 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 |