|
|||||||||
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.ChangeRequest org.jboss.dna.graph.request.SetPropertyRequest
public class SetPropertyRequest
Instruction to set a particular property on the node at the specified location. This request never removes the node, even if the property is empty.
Constructor Summary | |
---|---|
SetPropertyRequest(Location on,
String workspaceName,
Property property)
Create a request to set the property on the node at the supplied location. |
Method Summary | |
---|---|
void |
cancel()
Cancel this request. |
Location |
changedLocation()
Get the location of the top-most node that is to be changed by this request. |
String |
changedWorkspace()
Get the name of the workspace that was changed by this request. |
boolean |
changes(String workspace,
Path path)
Determine if this request changes the branch at the given path. |
boolean |
equals(Object obj)
|
Location |
getActualLocationOfNode()
Get the actual location of the node that was updated. |
int |
hashCode()
|
String |
inWorkspace()
Get the name of the workspace in which the node exists. |
boolean |
isReadOnly()
Return whether this request only reads information. |
Location |
on()
Get the location defining the node that is to be updated. |
Property |
property()
Get the property that is being set. |
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.request.Request |
---|
freeze, getError, hasError, isCancelled, isFrozen, setError |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SetPropertyRequest(Location on, String workspaceName, Property property)
on
- the location of the node to be readworkspaceName
- the name of the workspace containing the nodeproperty
- the new property on the node
IllegalArgumentException
- if the location, workspace name, or property is nullMethod Detail |
---|
public boolean isReadOnly()
isReadOnly
in class Request
Request.isReadOnly()
public Location on()
public String inWorkspace()
public Property property()
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.
IllegalStateException
- if the request is frozenpublic Location getActualLocationOfNode()
public boolean changes(String workspace, Path path)
changes
in class ChangeRequest
workspace
- the name of the workspace; may not be nullpath
- the path; may not be null
ChangeRequest.changes(java.lang.String, org.jboss.dna.graph.property.Path)
public void cancel()
cancellation flag
is set, and any current or
future processing of the request may be affected by the cancellation. (Note however, that processors may choose to not
respect this request.)
This method is safe to be called by different threads.
cancel
in class Request
Request.cancel()
public int hashCode()
hashCode
in class Object
Object.hashCode()
public boolean equals(Object obj)
equals
in class Object
Object.equals(java.lang.Object)
public Location changedLocation()
changedLocation
in class ChangeRequest
ChangeRequest.changedLocation()
public String changedWorkspace()
changedWorkspace
in class ChangeRequest
ChangeRequest.changedWorkspace()
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 |