org.opencms.relations

Enum CmsRelationType.CopyBehavior

java.lang.Object

java.lang.Enum<CmsRelationType.CopyBehavior>

org.opencms.relations.CmsRelationType.CopyBehavior

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CmsRelationType.CopyBehavior>

Enclosing class:

CmsRelationType

public static enum CmsRelationType.CopyBehavior
extends java.lang.Enum<CmsRelationType.CopyBehavior>

Enum representing how relations should be handled while copying resources.

Enum Constant Summary

Enum Constants

Enum Constant and Description
copy Copy the relation when copying a resource.
ignore Ignore the relation when copying a resource.

Method Summary

Modifier and Type	Method and Description
static CmsRelationType.CopyBehavior	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CmsRelationType.CopyBehavior[]	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

copy

public static final CmsRelationType.CopyBehavior copy

Copy the relation when copying a resource.

ignore

public static final CmsRelationType.CopyBehavior ignore

Ignore the relation when copying a resource.

Method Detail

values

public static CmsRelationType.CopyBehavior[] 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 (CmsRelationType.CopyBehavior c : CmsRelationType.CopyBehavior.values())
    System.out.println(c);

Returns:

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

valueOf

public static CmsRelationType.CopyBehavior valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null