org.alfresco.module.vti.metadata.dic

Enum RenameOption

java.lang.Object

java.lang.Enum<RenameOption>

org.alfresco.module.vti.metadata.dic.RenameOption

All Implemented Interfaces:

Serializable, Comparable<RenameOption>

public enum RenameOption
extends Enum<RenameOption>

Define the behaviors of a rename operation.

Author:

Michael Shavnev

Enum Constant Summary

Enum Constants

Enum Constant and Description
createdir Creates the parent directory if it does not already exist.
findbacklinks Requests that servers, implementing link fixup, fix the linked files other than those moved.
nochangeall Do not perform link fixup on links in moved documents.
none The client MUST send "none" if it does not want to specify any of the options given by a RENAME-OPTION-VAL.
patchprefix Simulates the move of a directory rather than a file.

Method Summary

Modifier and Type	Method and Description
static EnumSet<RenameOption>	getOptions(String stringValues)
static RenameOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static RenameOption[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

none

public static final RenameOption none

The client MUST send "none" if it does not want to specify any of the options given by a RENAME-OPTION-VAL.

createdir

public static final RenameOption createdir

Creates the parent directory if it does not already exist.

findbacklinks

public static final RenameOption findbacklinks

Requests that servers, implementing link fixup, fix the linked files other than those moved.

nochangeall

public static final RenameOption nochangeall

Do not perform link fixup on links in moved documents.

patchprefix

public static final RenameOption patchprefix

Simulates the move of a directory rather than a file.

Method Detail

values

public static RenameOption[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RenameOption c : RenameOption.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RenameOption valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getOptions

public static EnumSet<RenameOption> getOptions(String stringValues)