Package com.helger.base.io

Enum Class EAppend

java.lang.Object

java.lang.Enum<EAppend>

com.helger.base.io.EAppend

All Implemented Interfaces:

Serializable, Comparable<EAppend>, Constable, BooleanSupplier

public enum EAppend
extends Enum<EAppend>
implements BooleanSupplier

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

Author:

Philip Helger

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
APPEND	Append to an existing object
TRUNCATE	Truncate an eventually existing object and start over

Field Summary

Fields

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

Method Summary

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

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 Details

DEFAULT

public static final @NonNull EAppend DEFAULT

The default is TRUNCATE

Method Details

values

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

getAsBoolean

public boolean getAsBoolean()

Specified by:

getAsBoolean in interface BooleanSupplier

isAppend

public boolean isAppend()

Returns:

true if this is APPEND, false otherwise.

isTruncate

public boolean isTruncate()

Returns:

true if this is TRUNCATE, false otherwise.

getAsOpenOptions

public @NonNull OpenOption[] getAsOpenOptions()

Returns:

The matching NIO OpenOption array for this append mode. Never null.