Package com.github.tadukoo.java.annotation

Class JavaAnnotationBuilder<AnnotationType extends JavaAnnotation>

java.lang.Object

com.github.tadukoo.java.annotation.JavaAnnotationBuilder<AnnotationType>

Direct Known Subclasses:

EditableJavaAnnotation.EditableJavaAnnotationBuilder, UneditableJavaAnnotation.UneditableJavaAnnotationBuilder

public abstract class JavaAnnotationBuilder<AnnotationType extends JavaAnnotation>
extends Object

Java Annotation Builder is used to build a new JavaAnnotation. It contains the following parameters:

Java Annotation Parameters

Parameter	Description	Default or Required
name	The name of the annotation	Required

Since:

Alpha v.0.3 (within JavaAnnotation), Alpha v.0.4 (on its own)

Version:

Beta v.0.5

Author:

Logan Ferree (Tadukoo)

Field Summary

Fields

Modifier and Type	Field	Description
protected String	canonicalName	The canonical name of the annotation
protected String	name	The name of the annotation
protected List<com.github.tadukoo.util.tuple.Pair<String,String>>	parameters	The parameters of the annotation (as Pairs of name and value)

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JavaAnnotationBuilder()	Constructs a new JavaAnnotationBuilder

Method Summary

Modifier and Type	Method	Description
AnnotationType	build()	Checks for any errors in the current parameters, then builds a new JavaAnnotation
JavaAnnotationBuilder<AnnotationType>	canonicalName(String canonicalName)
protected abstract AnnotationType	constructAnnotation()	Constructs a new JavaAnnotation with the given parameters
JavaAnnotationBuilder<AnnotationType>	copy(JavaAnnotation annotation)	Copies the settings on the given annotation into the builder
JavaAnnotationBuilder<AnnotationType>	name(String name)
JavaAnnotationBuilder<AnnotationType>	parameter(com.github.tadukoo.util.tuple.Pair<String,String> parameter)
JavaAnnotationBuilder<AnnotationType>	parameter(String name, String value)
JavaAnnotationBuilder<AnnotationType>	parameters(List<com.github.tadukoo.util.tuple.Pair<String,String>> parameters)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

name

protected String name

The name of the annotation

canonicalName

protected String canonicalName

The canonical name of the annotation

parameters

protected List<com.github.tadukoo.util.tuple.Pair<String,String>> parameters

The parameters of the annotation (as Pairs of name and value)

Constructor Details

JavaAnnotationBuilder

protected JavaAnnotationBuilder()

Constructs a new JavaAnnotationBuilder

Method Details

copy

public JavaAnnotationBuilder<AnnotationType> copy(JavaAnnotation annotation)

Copies the settings on the given annotation into the builder

Parameters:

annotation - The annotation to copy settings from

Returns:

this, to continue building

name

public JavaAnnotationBuilder<AnnotationType> name(String name)

Parameters:

name - The name of the annotation

Returns:

this, to continue building

canonicalName

public JavaAnnotationBuilder<AnnotationType> canonicalName(String canonicalName)

Parameters:

canonicalName - The canonical name of the annotation

Returns:

this, to continue building

parameter

public JavaAnnotationBuilder<AnnotationType> parameter(String name,
 String value)

Parameters:

name - The name of the parameter to be added

value - The value of the parameter to be added

Returns:

this, to continue building

parameter

public JavaAnnotationBuilder<AnnotationType> parameter(com.github.tadukoo.util.tuple.Pair<String,String> parameter)

Parameters:

parameter - The parameter to be added (as a Pair of name and value)

Returns:

this, to continue building

parameters

public JavaAnnotationBuilder<AnnotationType> parameters(List<com.github.tadukoo.util.tuple.Pair<String,String>> parameters)

Parameters:

parameters - The parameters of the annotation (as Pairs of name and value)

Returns:

this, to continue building

build

public AnnotationType build()

Checks for any errors in the current parameters, then builds a new JavaAnnotation

Returns:

A newly built JavaAnnotation

Throws:

IllegalArgumentException - if anything is wrong with the current parameters

constructAnnotation

protected abstract AnnotationType constructAnnotation()

Constructs a new JavaAnnotation with the given parameters

Returns:

The newly constructed JavaAnnotation