Package de.xima.fc.mdl.enums

Enum EPluginReplacementStatus

java.lang.Object

java.lang.Enum<EPluginReplacementStatus>

de.xima.fc.mdl.enums.EPluginReplacementStatus

All Implemented Interfaces:

Serializable, Comparable<EPluginReplacementStatus>

public enum EPluginReplacementStatus
extends Enum<EPluginReplacementStatus>

Enumeration with the status of a placeholder replacement plugin. Indicates whether a plugin could resolve a placeholder.

Since:

8.0.0

Author:

XIMA MEDIA GmbH

Enum Constant Summary

Enum Constants

Enum Constant	Description
LEGACY	Deprecated. For backwards compatibility only, use either REPLACED or NOT_REPLACED.
NOT_REPLACED	The placeholder could not be resolved.
REPLACED	The placeholder could be resolved, the returned value should be used as the resolved value of the placeholder.

Method Summary

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

REPLACED

public static final EPluginReplacementStatus REPLACED

The placeholder could be resolved, the returned value should be used as the resolved value of the placeholder.

NOT_REPLACED

public static final EPluginReplacementStatus NOT_REPLACED

The placeholder could not be resolved. Other placeholder plugins should be attempted, and if no plugin can resolve the placeholder, placeholder resolution fails.

LEGACY

@Deprecated
public static final EPluginReplacementStatus LEGACY

Deprecated.

For backwards compatibility only, use either REPLACED or NOT_REPLACED.

Legacy mode for deciding whether the placeholder could be resolved. When the resolved value equals the placeholder content, the placeholder is treated as if it could not be resolved. Otherwise, it is treated as resolved.

Method Detail

values

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

Returns:

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

valueOf

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