Module com.speedment.common.codegen

Package com.speedment.common.codegen.constant

Enum DefaultAnnotationUsage

java.lang.Object

java.lang.Enum<DefaultAnnotationUsage>

com.speedment.common.codegen.constant.DefaultAnnotationUsage

All Implemented Interfaces:

AnnotationUsage, HasCopy<AnnotationUsage>, HasType<AnnotationUsage>, HasValue<AnnotationUsage>, Serializable, Comparable<DefaultAnnotationUsage>

public enum DefaultAnnotationUsage
extends Enum<DefaultAnnotationUsage>
implements AnnotationUsage

An enumeration with default constants for the AnnotationUsage interface. If any of the setter methods are called, the model will be cloned into a non-enum value before the value is changed in the clone. This makes it possible to safely set values in the constants without changing their actual state.

Author:

Emil Forslund

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEPRECATED
DOCUMENTED
INHERITED
NATIVE
OVERRIDE
REPEATABLE
RETENTION
SUPPRESS_WARNINGS_UNCHECKED
TARGET

Method Summary

Modifier and Type	Method	Description
AnnotationUsage	copy()	Create a deep copy of this model if it is mutable.
Type	getType()	Returns the type of this model.
Optional<Value<?>>	getValue()	Returns the value of this model.
List<Map.Entry<String,Value<?>>>	getValues()	Returns a list of all the key-value pairs in this model.
AnnotationUsage	put(String key, Value<?> val)	Use the specified key-value pair when referencing the annotation.
AnnotationUsage	set(Value<?> val)	Sets the value of this model.
AnnotationUsage	set(Type type)	Sets the type of this model.
static DefaultAnnotationUsage	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DefaultAnnotationUsage[]	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

Methods inherited from interface com.speedment.common.codegen.model.AnnotationUsage

put, put

Methods inherited from interface com.speedment.common.codegen.model.trait.HasValue

set, set, set

Enum Constant Detail

OVERRIDE

public static final DefaultAnnotationUsage OVERRIDE

DOCUMENTED

public static final DefaultAnnotationUsage DOCUMENTED

INHERITED

public static final DefaultAnnotationUsage INHERITED

NATIVE

public static final DefaultAnnotationUsage NATIVE

REPEATABLE

public static final DefaultAnnotationUsage REPEATABLE

RETENTION

public static final DefaultAnnotationUsage RETENTION

TARGET

public static final DefaultAnnotationUsage TARGET

DEPRECATED

public static final DefaultAnnotationUsage DEPRECATED

SUPPRESS_WARNINGS_UNCHECKED

public static final DefaultAnnotationUsage SUPPRESS_WARNINGS_UNCHECKED

Method Detail

values

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

Returns:

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

valueOf

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

set

public AnnotationUsage set(Type type)

Sets the type of this model.

Since this is a constant, the model will first be copied and the operation will then be performed on the copy.

Specified by:

set in interface HasType<AnnotationUsage>

Parameters:

type - the new type

Returns:

a reference to this

set

public AnnotationUsage set(Value<?> val)

Sets the value of this model.

Since this is a constant, the model will first be copied and the operation will then be performed on the copy.

Specified by:

set in interface HasValue<AnnotationUsage>

Parameters:

val - the new value

Returns:

a reference to this

put

public AnnotationUsage put(String key,
                           Value<?> val)

Use the specified key-value pair when referencing the annotation. If you only want to show a single value without any key, consider using the HasValue.set(Value) method.

Since this is a constant, the model will first be copied and the operation will then be performed on the copy.

Specified by:

put in interface AnnotationUsage

Parameters:

key - the key

val - the value

Returns:

a reference to this model

getType

public Type getType()

Description copied from interface: HasType

Returns the type of this model.

Specified by:

getType in interface HasType<AnnotationUsage>

Returns:

the type

getValue

public Optional<Value<?>> getValue()

Description copied from interface: HasValue

Returns the value of this model.

Specified by:

getValue in interface HasValue<AnnotationUsage>

Returns:

the value

getValues

public List<Map.Entry<String,Value<?>>> getValues()

Description copied from interface: AnnotationUsage

Returns a list of all the key-value pairs in this model.

Specified by:

getValues in interface AnnotationUsage

Returns:

all key-value pairs

copy

public AnnotationUsage copy()

Description copied from interface: HasCopy

Create a deep copy of this model if it is mutable. If this class is not mutable, then this method may return itself. If the model implements HasParent, then the parent property will not be copied. Instead it will be set to null.

Specified by:

copy in interface HasCopy<AnnotationUsage>

Returns:

the copy