Module com.speedment.common.codegen

Package com.speedment.common.codegen.model

Interface AnnotationUsage

All Superinterfaces:

HasCopy<AnnotationUsage>, HasType<AnnotationUsage>, HasValue<AnnotationUsage>

All Known Implementing Classes:

DefaultAnnotationUsage

public interface AnnotationUsage
extends HasCopy<AnnotationUsage>, HasType<AnnotationUsage>, HasValue<AnnotationUsage>

A model that represents the usage of a particular annotation in code.

Since:

2.0

Author:

Emil Forslund

See Also:

Annotation

Method Summary

Modifier and Type	Method	Description
List<Map.Entry<String,Value<?>>>	getValues()	Returns a list of all the key-value pairs in this model.
static AnnotationUsage	of(Type type)	Creates a new instance implementing this interface by using the default implementation.
AnnotationUsage	put(String key, Value<?> val)	Use the specified key-value pair when referencing the annotation.
default AnnotationUsage	put(String key, Number numberValue)	Use the specified key-value pair when referencing the annotation.
default AnnotationUsage	put(String key, String textValue)	Use the specified key-value pair when referencing the annotation.

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

copy

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

getType, set

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

getValue, set, set, set, set

Method Detail

put

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.

Parameters:

key - the key

val - the value

Returns:

a reference to this model

put

default AnnotationUsage put(String key,
                            String textValue)

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.

This method works like put(String, Value) except that the type of the value is automatically determined as a TextValue.

Parameters:

key - the key

textValue - the value

Returns:

a reference to this model

Since:

2.5

put

default AnnotationUsage put(String key,
                            Number numberValue)

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.

This method works like put(String, Value) except that the type of the value is automatically determined as a NumberValue.

Parameters:

key - the key

numberValue - the value

Returns:

a reference to this model

Since:

2.5

getValues

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

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

Returns:

all key-value pairs

of

static AnnotationUsage of(Type type)

Creates a new instance implementing this interface by using the default implementation.

Parameters:

type - the type

Returns:

the new instance