Package com.github.tadukoo.java.annotation

Class JavaAnnotation

java.lang.Object

com.github.tadukoo.java.annotation.JavaAnnotation

All Implemented Interfaces:

JavaCodeType, JavaTokens

Direct Known Subclasses:

EditableJavaAnnotation, UneditableJavaAnnotation

public abstract class JavaAnnotation
extends Object
implements JavaCodeType

Represents an annotation in Java.

Since:

Alpha v.0.3 (as old version that is now more like UneditableJavaAnnotation), Alpha v.0.4 (as newer version)

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)

Fields inherited from interface com.github.tadukoo.java.JavaCodeType

NEWLINE_WITH_2_TABS, NEWLINE_WITH_4_TABS

Fields inherited from interface com.github.tadukoo.java.JavaTokens

ABSTRACT_MODIFIER, ANNOTATION_START_TOKEN, ASSIGNMENT_OPERATOR_TOKEN, BLOCK_CLOSE_TOKEN, BLOCK_OPEN_TOKEN, CLASS_TOKEN, EXTENDS_TOKEN, FINAL_MODIFIER, IMPLEMENTS_TOKEN, IMPORT_TOKEN, JAVADOC_AUTHOR_TOKEN, JAVADOC_LINE_TOKEN, JAVADOC_PARAM_TOKEN, JAVADOC_RETURN_TOKEN, JAVADOC_SINCE_TOKEN, JAVADOC_START_TOKEN, JAVADOC_VERSION_TOKEN, LIST_SEPARATOR_TOKEN, MODIFIERS, MULTI_LINE_COMMENT_CLOSE_TOKEN, MULTI_LINE_COMMENT_START_TOKEN, PACKAGE_TOKEN, PARAMETER_CLOSE_TOKEN, PARAMETER_OPEN_TOKEN, PRIVATE_MODIFIER, PROTECTED_MODIFIER, PUBLIC_MODIFIER, SEMICOLON, SINGLE_LINE_COMMENT_TOKEN, STATIC_MODIFIER, THROWS_TOKEN, VISIBILITY_MODIFIERS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JavaAnnotation(boolean editable, String name, String canonicalName, List<com.github.tadukoo.util.tuple.Pair<String,String>> parameters)	Constructs a new JavaAnnotation with the given parameters

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object otherAnnotation)
String	getCanonicalName()
JavaCodeTypes	getJavaCodeType()
String	getName()
List<com.github.tadukoo.util.tuple.Pair<String,String>>	getParameters()
Map<String,String>	getParametersMap()
boolean	isEditable()
String	toBuilderCode()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.tadukoo.java.JavaCodeType

escapeQuotes

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

JavaAnnotation

protected JavaAnnotation(boolean editable,
 String name,
 String canonicalName,
 List<com.github.tadukoo.util.tuple.Pair<String,String>> parameters)

Constructs a new JavaAnnotation with the given parameters

Parameters:

editable - Whether the annotation is editable or not

name - The name of the annotation

canonicalName - The canonical name of the annotation

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

Method Details

getJavaCodeType

public JavaCodeTypes getJavaCodeType()

Specified by:

getJavaCodeType in interface JavaCodeType

Returns:

What type this is

isEditable

public boolean isEditable()

Returns:

Whether the annotation is editable or not

getName

public String getName()

Returns:

The name of the annotation

getCanonicalName

public String getCanonicalName()

Returns:

The canonical name of the annotation

getParameters

public List<com.github.tadukoo.util.tuple.Pair<String,String>> getParameters()

Returns:

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

getParametersMap

public Map<String,String> getParametersMap()

Returns:

The parameters of the annotation as a Map of parameter name to value

toString

public String toString()

Overrides:

toString in class Object

Returns:

This Java Annotation as a string, ready to be put in some Java code

equals

public boolean equals(Object otherAnnotation)

Overrides:

equals in class Object

toBuilderCode

public String toBuilderCode()

Specified by:

toBuilderCode in interface JavaCodeType

Returns:

The String of code to build the JavaCodeType