com.phloc.commons.io

Enum EAppend

java.lang.Object

java.lang.Enum<EAppend>

com.phloc.commons.io.EAppend

All Implemented Interfaces:

IHasBooleanRepresentation, Serializable, Comparable<EAppend>

public enum EAppend
extends Enum<EAppend>
implements IHasBooleanRepresentation

Small enum for determining the append or truncate state of output streams.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPEND Append to an existing object
TRUNCATE Truncate an eventually existing object and start over

Field Summary

Fields

Modifier and Type	Field and Description
static EAppend	DEFAULT The default is TRUNCATE

Method Summary

Methods

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

APPEND

public static final EAppend APPEND

Append to an existing object

TRUNCATE

public static final EAppend TRUNCATE

Truncate an eventually existing object and start over

Field Detail

DEFAULT

@Nonnull
public static final EAppend DEFAULT

The default is TRUNCATE

Method Detail

values

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

Returns:

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

valueOf

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

getAsBoolean

public boolean getAsBoolean()

Specified by:

getAsBoolean in interface IHasBooleanRepresentation

Returns:

The boolean representation of this object.

isAppend

public boolean isAppend()

isTruncate

public boolean isTruncate()