Package pl.edu.icm.unity.engine.api.translation.in

Enum AttributeEffectMode

java.lang.Object

java.lang.Enum<AttributeEffectMode>

pl.edu.icm.unity.engine.api.translation.in.AttributeEffectMode

All Implemented Interfaces:

Serializable, Comparable<AttributeEffectMode>

public enum AttributeEffectMode
extends Enum<AttributeEffectMode>

Defines how a mapped attribute should be handled.

Author:

K. Benedyczak

Enum Constant Summary

Enum Constants

Enum Constant	Description
CREATE_ONLY	If the local attribute doesn't exist it will be created.
CREATE_OR_UPDATE	Local attribute will be created if doesn't exists.
UPDATE_ONLY	If a local attribute exists it will be updated.

Method Summary

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

CREATE_OR_UPDATE

public static final AttributeEffectMode CREATE_OR_UPDATE

Local attribute will be created if doesn't exists. If it does, then the values will be set to the new value.

UPDATE_ONLY

public static final AttributeEffectMode UPDATE_ONLY

If a local attribute exists it will be updated. If it doesn't nothing will be done.

CREATE_ONLY

public static final AttributeEffectMode CREATE_ONLY

If the local attribute doesn't exist it will be created. If it does nothing will be done.

Method Detail

values

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

Returns:

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

valueOf

public static AttributeEffectMode 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