Enum Clusivity

java.lang.Object

java.lang.Enum<Clusivity>

com.lokalized.Clusivity

All Implemented Interfaces:

LanguageForm, Serializable, Comparable<Clusivity>, Constable

public enum Clusivity
extends Enum<Clusivity>
implements LanguageForm

Language clusivity forms.

Since:

1.2.0

Author:

Mark Allen

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXCLUSIVE	Exclusive "we/us" (excludes the addressee).
INCLUSIVE	Inclusive "we/us" (includes the addressee).

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INCLUSIVE

public static final Clusivity INCLUSIVE

Inclusive "we/us" (includes the addressee).

EXCLUSIVE

public static final Clusivity EXCLUSIVE

Exclusive "we/us" (excludes the addressee).

Method Details

values

public static Clusivity[] values()

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

Returns:

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

valueOf

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