Package com.ultikits.ultitools.config.document

Enum Class OperatorFileWriter.Outcome

java.lang.Object

java.lang.Enum<OperatorFileWriter.Outcome>

com.ultikits.ultitools.config.document.OperatorFileWriter.Outcome

All Implemented Interfaces:

Serializable, Comparable<OperatorFileWriter.Outcome>, java.lang.constant.Constable

Enclosing class:

OperatorFileWriter

public static enum OperatorFileWriter.Outcome
extends Enum<OperatorFileWriter.Outcome>

What a write did.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FILE_CHANGED	The file was not what the caller read, or it moved before publishing; nothing was written.
REFUSED	The write would have changed bytes it does not own, or the file cannot be written safely.
UNCHANGED	The edit changed nothing; the file was not touched.
WRITTEN	The edited file was published.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Outcome()

Method Summary

Modifier and Type	Method	Description
static OperatorFileWriter.Outcome	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OperatorFileWriter.Outcome[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

WRITTEN

public static final OperatorFileWriter.Outcome WRITTEN

The edited file was published.

UNCHANGED

public static final OperatorFileWriter.Outcome UNCHANGED

The edit changed nothing; the file was not touched.

FILE_CHANGED

public static final OperatorFileWriter.Outcome FILE_CHANGED

The file was not what the caller read, or it moved before publishing; nothing was written.

REFUSED

public static final OperatorFileWriter.Outcome REFUSED

The write would have changed bytes it does not own, or the file cannot be written safely.

Constructor Details

Outcome

private Outcome()

Method Details

values

public static OperatorFileWriter.Outcome[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static OperatorFileWriter.Outcome valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null