|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.modeshape.graph.request.Request
org.modeshape.graph.request.ChangeRequest
org.modeshape.graph.request.DeleteChildrenRequest
public class DeleteChildrenRequest
Instruction that all nodes below a supplied node be deleted. This is similar to DeleteBranchRequest
, except that the
parent node (top node in the branch) is not deleted.
Constructor Summary | |
---|---|
DeleteChildrenRequest(Location at,
String workspaceName)
Create a request to delete all children of the supplied node. |
Method Summary | |
---|---|
void |
addDeletedChild(Location child)
Add to the list of children that has been read the child with the given path and identification properties. |
void |
addDeletedChild(Path pathToChild,
Property idProperty)
Add to the list of children that has been read the child with the given path and identification property. |
void |
addDeletedChild(Path pathToChild,
Property firstIdProperty,
Property... remainingIdProperties)
Add to the list of children that has been read the child with the given path and identification properties. |
void |
addDeletedChildren(Iterable<Location> children)
Add to the list of children that has been read the supplied children with the given path and identification properties. |
Location |
at()
Get the location defining the top of the branch to be deleted |
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. |
DeleteChildrenRequest |
clone()
This method does not clone the results. |
boolean |
equals(Object obj)
|
List<Location> |
getActualChildrenDeleted()
Get the list of the actual children that were deleted. |
Location |
getActualLocationOfNode()
Get the actual location of the node that was deleted. |
RequestType |
getType()
Returns the type of the request |
String |
inWorkspace()
Get the name of the workspace in which the branch exists. |
boolean |
isReadOnly()
Return whether this request only reads information. |
void |
setActualLocationOfNode(Location actual)
Sets the actual and complete location of the node being deleted. |
String |
toString()
|
Methods inherited from class org.modeshape.graph.request.Request |
---|
cancel, checkNotFrozen, freeze, getError, hasError, isCancelled, isFrozen, printable, printable, setError, setLatchForFreezing |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DeleteChildrenRequest(Location at, String workspaceName)
at
- the location of the parent nodeworkspaceName
- the name of the workspace containing the parent
IllegalArgumentException
- if the location or workspace name is nullMethod Detail |
---|
public Location at()
public String inWorkspace()
public boolean isReadOnly()
isReadOnly
in class Request
Request.isReadOnly()
public void setActualLocationOfNode(Location actual)
path
.
actual
- the actual location of the node being deleted, or null if the current location
should be used
IllegalArgumentException
- if the actual location null or does not have a path.
IllegalStateException
- if the request is frozenpublic void addDeletedChildren(Iterable<Location> children)
children
- the locations of the children that were read
IllegalArgumentException
- if the parameter is null
IllegalStateException
- if the request is frozenaddDeletedChild(Location)
,
addDeletedChild(Path, Property)
,
addDeletedChild(Path, Property, Property...)
public void addDeletedChild(Location child)
child
- the location of the child that was read
IllegalArgumentException
- if the location is null
IllegalStateException
- if the request is frozenaddDeletedChild(Path, Property)
,
addDeletedChild(Path, Property, Property...)
public void addDeletedChild(Path pathToChild, Property firstIdProperty, Property... remainingIdProperties)
pathToChild
- the path of the child that was just readfirstIdProperty
- the first identification property of the child that was just readremainingIdProperties
- the remaining identification properties of the child that was just read
IllegalArgumentException
- if the path or identification properties are null
IllegalStateException
- if the request is frozenaddDeletedChild(Location)
,
addDeletedChild(Path, Property)
public void addDeletedChild(Path pathToChild, Property idProperty)
pathToChild
- the path of the child that was just readidProperty
- the identification property of the child that was just read
IllegalArgumentException
- if the path or identification properties are null
IllegalStateException
- if the request is frozenaddDeletedChild(Location)
,
addDeletedChild(Path, Property, Property...)
public List<Location> getActualChildrenDeleted()
public 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.modeshape.graph.property.Path)
public Location changedLocation()
path
.
changedLocation
in class ChangeRequest
ChangeRequest.changedLocation()
public String changedWorkspace()
changedWorkspace
in class ChangeRequest
ChangeRequest.changedWorkspace()
public boolean equals(Object obj)
equals
in class Object
Object.equals(java.lang.Object)
public String toString()
toString
in class Object
Object.toString()
public DeleteChildrenRequest clone()
This method does not clone the results.
This method does not clone the results.
clone
in class ChangeRequest
ChangeRequest.clone()
public RequestType getType()
Request
getType
in class Request
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |