Package com.myscript.iink

Enum Class PackageOpenOption

java.lang.Object

java.lang.Enum<PackageOpenOption>

com.myscript.iink.PackageOpenOption

All Implemented Interfaces:

Serializable, Comparable<PackageOpenOption>, Constable

public enum PackageOpenOption
extends Enum<PackageOpenOption>

Describes the different options given when opening a package.

Since:

1.2

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
CREATE	Create a new package if it does not exist.
CREATE_NEW	Create a new package, failing if it already exists.
EXISTING	Open an existing package.
TRUNCATE_EXISTING	If the package already exists then its content is discarded.

Method Summary

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

EXISTING

public static final PackageOpenOption EXISTING

Open an existing package.

CREATE

public static final PackageOpenOption CREATE

Create a new package if it does not exist.

CREATE_NEW

public static final PackageOpenOption CREATE_NEW

Create a new package, failing if it already exists.

TRUNCATE_EXISTING

public static final PackageOpenOption TRUNCATE_EXISTING

If the package already exists then its content is discarded.

Method Details

values

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