com.jalios.jcms.fileprocessor.processingmanagement
Enum ProcessingStatus

java.lang.Object
  java.lang.Enum<ProcessingStatus>
      com.jalios.jcms.fileprocessor.processingmanagement.ProcessingStatus

All Implemented Interfaces:

Serializable, Comparable<ProcessingStatus>

public enum ProcessingStatus
extends Enum<ProcessingStatus>

Processing and Indexing status

Enum Constant Summary

DELETED

ERROR

GLOBALLY_BLACKLISTED

IGNORED

PARTIALLY_BLACKLISTED

SUCCESSFUL

Method Summary

static ProcessingStatus	get(int code) Retrieve the ProcessingStatus corresponding to the specified ProcessingStatus's code
int	getCode() Retrieve an internal and unique integer for this ProcessingStatus, suitable for serialization
String	getText(String lang) Retrieve an I18Ned string describing this ProcessingStatus
boolean	isBlacklisted() Check if this status a blacklisting status (either globally or partially)
static ProcessingStatus	mergeStatuses(EnumSet<ProcessingStatus> statuses) Retrieve the worst status from the specified ones
static ProcessingStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static ProcessingStatus[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

IGNORED

public static final ProcessingStatus IGNORED

SUCCESSFUL

public static final ProcessingStatus SUCCESSFUL

DELETED

public static final ProcessingStatus DELETED

ERROR

public static final ProcessingStatus ERROR

PARTIALLY_BLACKLISTED

public static final ProcessingStatus PARTIALLY_BLACKLISTED

GLOBALLY_BLACKLISTED

public static final ProcessingStatus GLOBALLY_BLACKLISTED

Method Detail

values

public static final ProcessingStatus[] values()

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

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

Returns:

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

valueOf

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

get

public static ProcessingStatus get(int code)

Retrieve the ProcessingStatus corresponding to the specified ProcessingStatus's code

Parameters:

code - the interger value as returned by getCode()

Returns:

the corresponding ProcessingStatus instance of ProcessingStatus.IGNORED if none could be found for the specified code.

getCode

public final int getCode()

Retrieve an internal and unique integer for this ProcessingStatus, suitable for serialization

Returns:

an unique integer describing this status

See Also:

get(int)

getText

public final String getText(String lang)

Retrieve an I18Ned string describing this ProcessingStatus

Parameters:

lang - the ISO-639 language code in which to retrieve the ProcessingStatus description

Returns:

a description of this ProcessingStatus

isBlacklisted

public final boolean isBlacklisted()

Check if this status a blacklisting status (either globally or partially)

Returns:

true if this is status is a blacklisting status, false otherwise

mergeStatuses

public static ProcessingStatus mergeStatuses(EnumSet<ProcessingStatus> statuses)

Retrieve the worst status from the specified ones

Parameters:

statuses - an set of ProcessingStatus

Returns:

return the worst ProcessingStatus, or ProcessingStatus.IGNORED if the specified set was empty