org.modeshape.graph.request
Class DeleteBranchRequest

java.lang.Object
  extended by org.modeshape.graph.request.Request
      extended by org.modeshape.graph.request.ChangeRequest
          extended by org.modeshape.graph.request.DeleteBranchRequest
All Implemented Interfaces:
Serializable, Cloneable

public class DeleteBranchRequest
extends ChangeRequest

Instruction that a branch be deleted.

See Also:
Serialized Form

Constructor Summary
DeleteBranchRequest(Location at, String workspaceName)
          Create a request to delete a branch.
 
Method Summary
 Location at()
          Get the location defining the top of the branch to be deleted
 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.
 DeleteBranchRequest clone()
           This method does not clone the results.
 boolean equals(Object obj)
          
 Location getActualLocationOfNode()
          Get the actual location of the node that was deleted.
 int hashCode()
          
 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
checkNotFrozen, freeze, getError, hasError, isCancelled, isFrozen, setError, setLatchForFreezing
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DeleteBranchRequest

public DeleteBranchRequest(Location at,
                           String workspaceName)
Create a request to delete a branch.

Parameters:
at - the location of the top node in the existing branch that is to be deleted
workspaceName - the name of the workspace containing the parent
Throws:
IllegalArgumentException - if the location or workspace name is null
Method Detail

at

public Location at()
Get the location defining the top of the branch to be deleted

Returns:
the location of the branch; never null

inWorkspace

public String inWorkspace()
Get the name of the workspace in which the branch exists.

Returns:
the name of the workspace; never null

isReadOnly

public boolean isReadOnly()
Return whether this request only reads information.

Specified by:
isReadOnly in class Request
Returns:
true if this request reads information, or false if it requests that the repository content be changed in some way
See Also:
Request.isReadOnly()

setActualLocationOfNode

public void setActualLocationOfNode(Location actual)
Sets the actual and complete location of the node being deleted. This method must be called when processing the request, and the actual location must have a path.

Parameters:
actual - the actual location of the node being deleted, or null if the current location should be used
Throws:
IllegalArgumentException - if the actual location is not equal to the current location, or if the actual location does not have a path.
IllegalStateException - if the request is frozen

getActualLocationOfNode

public Location getActualLocationOfNode()
Get the actual location of the node that was deleted.

Returns:
the actual location, or null if the actual location was not set

changes

public boolean changes(String workspace,
                       Path path)
Determine if this request changes the branch at the given path.

Specified by:
changes in class ChangeRequest
Parameters:
workspace - the name of the workspace; may not be null
path - the path; may not be null
Returns:
true if this request changes a node under the given path
See Also:
ChangeRequest.changes(java.lang.String, org.modeshape.graph.property.Path)

changedLocation

public Location changedLocation()
Get the location of the top-most node that is to be changed by this request. If this request has been completed, this location will always have a path.

Specified by:
changedLocation in class ChangeRequest
Returns:
the location changed by this request
See Also:
ChangeRequest.changedLocation()

changedWorkspace

public String changedWorkspace()
Get the name of the workspace that was changed by this request.

Specified by:
changedWorkspace in class ChangeRequest
Returns:
the name of the workspace changed by this request
See Also:
ChangeRequest.changedWorkspace()

cancel

public void cancel()
Cancel this request. After this method is called, the 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.

Overrides:
cancel in class Request
See Also:
Request.cancel()

hashCode

public int hashCode()

Overrides:
hashCode in class Object
See Also:
Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:
equals in class Object
See Also:
Object.equals(java.lang.Object)

toString

public String toString()

Overrides:
toString in class Object
See Also:
Object.toString()

clone

public DeleteBranchRequest clone()

This method does not clone the results.

This method does not clone the results.

Specified by:
clone in class ChangeRequest
See Also:
ChangeRequest.clone()


Copyright © 2008-2010 JBoss, a division of Red Hat. All Rights Reserved.