|
||||||||||
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.RenameNodeRequest
public class RenameNodeRequest
Instruction to rename an existing node (but keep it under the same parent). The same-name-sibling index will be determined automatically, based upon it's current location within the list of children.
Constructor Summary | |
---|---|
RenameNodeRequest(Location at,
String workspaceName,
Name newName)
Create a request to rename the node at the supplied location. |
Method Summary | |
---|---|
Location |
at()
Get the location defining the node that is to be read. |
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 |
getActualLocationAfter()
Get the actual location of the node after being renamed. |
Location |
getActualLocationBefore()
Get the actual location of the node before being renamed. |
int |
hashCode()
|
String |
inWorkspace()
Get the name of the workspace in which the node exists. |
boolean |
isReadOnly()
Return whether this request only reads information. |
void |
setActualLocations(Location oldLocation,
Location newLocation)
Sets the actual and complete location of the node being renamed and its new location. |
Name |
toName()
Get the new name for the node. |
String |
toString()
|
Methods inherited from class org.jboss.dna.graph.request.Request |
---|
freeze, getError, hasError, isCancelled, isFrozen, setError, setLatchForFreezing |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public RenameNodeRequest(Location at, String workspaceName, Name newName)
at
- the location of the node to be readworkspaceName
- the name of the workspace containing the nodenewName
- the new name for 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 Name toName()
public void setActualLocations(Location oldLocation, Location newLocation)
path
.
oldLocation
- the actual location of the node before being renamednewLocation
- the actual location of the node after being renamed
IllegalArgumentException
- if the either location is null or is missing its path, if the old location does not
represent the same location
as the current location
, if the new
location does not have the same parent as the old location, or if the new location does not have the same
name
on last segment
as that specified on the request
IllegalStateException
- if the request is frozenpublic Location getActualLocationBefore()
public Location getActualLocationAfter()
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 Location changedLocation()
changedLocation
in class ChangeRequest
ChangeRequest.changedLocation()
public String changedWorkspace()
changedWorkspace
in class ChangeRequest
ChangeRequest.changedWorkspace()
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 String toString()
toString
in class Object
Object.toString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |