com.fortyoneconcepts.valjogen.annotations.types

Enum Mutability

java.lang.Object

java.lang.Enum<Mutability>

com.fortyoneconcepts.valjogen.annotations.types.Mutability

All Implemented Interfaces:

Serializable, Comparable<Mutability>

public enum Mutability
extends Enum<Mutability>

Used by annotations to specify if generated output should be mutable, immutable or left to the tool to decide.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Immutable
Mutable
Undefined

Method Summary

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

Undefined

public static final Mutability Undefined

Mutable

public static final Mutability Mutable

Immutable

public static final Mutability Immutable

Method Detail

values

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

Returns:

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

valueOf

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

isMutable

public boolean isMutable()

isImmutable

public boolean isImmutable()