org.jboss.dna.graph.request
Class RemovePropertyRequest

java.lang.Object
  org.jboss.dna.graph.request.Request
      org.jboss.dna.graph.request.RemovePropertyRequest

All Implemented Interfaces:

Serializable, ChangeRequest

public class RemovePropertyRequest
extends Request
implements ChangeRequest

Instruction to remove the property with the supplied name from the node at the given location. This request has no net effect if the node does not contain a property with the supplied name.

Author:

Randall Hauch

See Also:

Serialized Form

Constructor Summary

RemovePropertyRequest(Location from, String workspaceName, Name propertyName)
Create a request to remove a named property from the node at the supplied location.

Method Summary

Location	changedLocation() Get the location of the top-most node that is to be 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	from() Get the location defining the node from which the property is to be removed.
Location	getActualLocationOfNode() Get the actual location of the node that was updated.
String	inWorkspace() Get the name of the workspace in which the node exists.
boolean	isReadOnly() Return whether this request only reads information.
Name	propertyName() Get the name of the property that is being removed.
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

cancel, getError, hasError, isCancelled, setError

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RemovePropertyRequest

public RemovePropertyRequest(Location from,
                             String workspaceName,
                             Name propertyName)

Create a request to remove a named property from the node at the supplied location.

Parameters:

from - the location of the node to be read

workspaceName - the name of the workspace containing the node

propertyName - the name of the property to be removed

Throws:

IllegalArgumentException - if the location, workspace name, or property name is null

Method Detail

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()

from

public Location from()

Get the location defining the node from which the property is to be removed.

Returns:

the location of the node; never null

inWorkspace

public String inWorkspace()

Get the name of the workspace in which the node exists.

Returns:

the name of the workspace; never null

propertyName

public Name propertyName()

Get the name of the property that is being removed.

Returns:

the property name; never null

setActualLocationOfNode

public void setActualLocationOfNode(Location actual)

Sets the actual and complete location of the node being updated. 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 updated, or null if the current location should be used

Throws:

IllegalArgumentException - if the actual location does represent the same location as the current location, or if the actual location does not have a path.

getActualLocationOfNode

public Location getActualLocationOfNode()

Get the actual location of the node that was updated.

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 interface 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.jboss.dna.graph.property.Path)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

changedLocation

public Location changedLocation()

Get the location of the top-most node that is to be changed by this request.

Specified by:

changedLocation in interface ChangeRequest

Returns:

the location changed by this request

See Also:

ChangeRequest.changedLocation()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()