|
||||||||||
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.CreateWorkspaceRequest
public final class CreateWorkspaceRequest
Request that a new workspace be created with the supplied name. The request also specifies the desired
behavior
for the recipient if a workspace already exists with the name.
Nested Class Summary | |
---|---|
static class |
CreateWorkspaceRequest.CreateConflictBehavior
The options for the behavior when a request specifies a workspace name that already is used by an existing workspace. |
Field Summary | |
---|---|
static CreateWorkspaceRequest.CreateConflictBehavior |
DEFAULT_CREATE_CONFLICT_BEHAVIOR
The default CreateWorkspaceRequest.CreateConflictBehavior that will be used if it is unspecified. |
Constructor Summary | |
---|---|
CreateWorkspaceRequest(String desiredNameOfNewWorkspace,
CreateWorkspaceRequest.CreateConflictBehavior createConflictBehavior)
Create a request to create a new workspace, and specify the behavior should a workspace already exists with a name that matches the desired name for the new workspace. |
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. |
CreateWorkspaceRequest |
clone()
This method does not clone the results. |
CreateWorkspaceRequest.CreateConflictBehavior |
conflictBehavior()
Get the desired behavior if a workspace already exists with the desired workspace name
. |
String |
desiredNameOfNewWorkspace()
Get the desired name for the new workspace. |
boolean |
equals(Object obj)
|
Location |
getActualLocationOfRoot()
Get the actual location of the root node in the new workspace, or null if the workspace was not (yet) created. |
String |
getActualWorkspaceName()
Get the actual name of the workspace that was created. |
RequestType |
getType()
Returns the type of the request |
int |
hashCode()
|
boolean |
isReadOnly()
Return whether this request only reads information. |
void |
setActualRootLocation(Location actualLocationOfRoot)
Set the actual location of the root node in the new workspace. |
void |
setActualWorkspaceName(String actualWorkspaceName)
Set the actual name of the workspace that was created. |
String |
toString()
|
Methods inherited from class org.modeshape.graph.request.Request |
---|
checkNotFrozen, freeze, getError, hasError, isCancelled, isFrozen, printable, printable, setError, setLatchForFreezing |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final CreateWorkspaceRequest.CreateConflictBehavior DEFAULT_CREATE_CONFLICT_BEHAVIOR
CreateWorkspaceRequest.CreateConflictBehavior
that will be used if it is unspecified.
Constructor Detail |
---|
public CreateWorkspaceRequest(String desiredNameOfNewWorkspace, CreateWorkspaceRequest.CreateConflictBehavior createConflictBehavior)
desiredNameOfNewWorkspace
- the desired name of the new workspacecreateConflictBehavior
- the behavior if a workspace already exists with the same nameMethod Detail |
---|
public String desiredNameOfNewWorkspace()
public CreateWorkspaceRequest.CreateConflictBehavior conflictBehavior()
desired workspace name
.
public String getActualWorkspaceName()
desired name
unless there was a conflict and the desired behavior
was to
alter the name
.
public void setActualWorkspaceName(String actualWorkspaceName)
desired name
unless there was a conflict and the desired behavior
was to
alter the name
.
actualWorkspaceName
- the actual name of the workspace that was created, or null if a workspace was not created
IllegalStateException
- if the request is frozenpublic Location getActualLocationOfRoot()
public void setActualRootLocation(Location actualLocationOfRoot)
actualLocationOfRoot
- the actual location of the workspace's root node.
IllegalStateException
- if the request is frozenpublic boolean isReadOnly()
isReadOnly
in class Request
Request.isReadOnly()
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()
public Location changedLocation()
path
.
changedLocation
in class ChangeRequest
ChangeRequest.changedLocation()
public String changedWorkspace()
changedWorkspace
in class ChangeRequest
ChangeRequest.changedWorkspace()
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 CreateWorkspaceRequest 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 |