public static enum DataspaceSet.DataspaceChildrenPolicy extends Enum<DataspaceSet.DataspaceChildrenPolicy>
Enum Constant and Description |
---|
INCLUDE_ALL_BRANCH_DESCENDANTS
All the branch descendants of the current dataspace will be included.
|
INCLUDE_ALL_DESCENDANTS
All the descendants of the current dataspace will be included.
|
INCLUDE_ALL_SNAPSHOT_DESCENDANTS
All the snapshot descendants of the current dataspace will be included.
|
INCLUDE_BRANCH_CHILDREN
Only direct branch children are automatically included in the result set.
|
INCLUDE_SNAPSHOT_CHILDREN
Only direct snapshot children are automatically included in the result set.
|
NONE
No child dataspace will be included.
|
Modifier and Type | Method and Description |
---|---|
String |
format()
Returns the code associated with this policy.
|
UserMessage |
getLabel()
Returns the policy label.
|
static DataspaceSet.DataspaceChildrenPolicy |
parseType(String aValue)
Parses a string value and returns the associated children policy.
|
static DataspaceSet.DataspaceChildrenPolicy |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static DataspaceSet.DataspaceChildrenPolicy[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final DataspaceSet.DataspaceChildrenPolicy NONE
public static final DataspaceSet.DataspaceChildrenPolicy INCLUDE_ALL_DESCENDANTS
public static final DataspaceSet.DataspaceChildrenPolicy INCLUDE_ALL_BRANCH_DESCENDANTS
public static final DataspaceSet.DataspaceChildrenPolicy INCLUDE_ALL_SNAPSHOT_DESCENDANTS
public static final DataspaceSet.DataspaceChildrenPolicy INCLUDE_BRANCH_CHILDREN
If the current dataspace is an initial snapshot, includes the associated branch (other snapshots do not have children). If the current dataspace is a branch, includes all the branches associated to the initial snapshots directly under this branch.
public static final DataspaceSet.DataspaceChildrenPolicy INCLUDE_SNAPSHOT_CHILDREN
If the current dataspace is a branch, includes the snapshots that are the direct children of this branch. If the current dataspace is a snapshot, includes the snapshots that are the direct children of its associated branch.
public static DataspaceSet.DataspaceChildrenPolicy[] values()
for (DataspaceSet.DataspaceChildrenPolicy c : DataspaceSet.DataspaceChildrenPolicy.values()) System.out.println(c);
public static DataspaceSet.DataspaceChildrenPolicy valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullpublic static DataspaceSet.DataspaceChildrenPolicy parseType(String aValue)
aValue
- the children policy as a literal stringpublic UserMessage getLabel()
public String format()