Package com.github.tadukoo.java.field

Class JavaField

java.lang.Object

com.github.tadukoo.java.field.JavaField

All Implemented Interfaces:

JavaCodeType, JavaTokens

Direct Known Subclasses:

EditableJavaField, UneditableJavaField

public abstract class JavaField
extends Object
implements JavaCodeType

Java Field represents a field in a Java class

Since:

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

Version:

Beta v.0.6

Author:

Logan Ferree (Tadukoo)

Field Summary

Fields

Modifier and Type	Field	Description
protected List<JavaAnnotation>	annotations	The annotations on the field
protected boolean	isFinal	Whether the field is final or not
protected boolean	isStatic	Whether the field is static or not
protected Javadoc	javadoc	The Javadoc on the field
protected String	name	The name of the field
protected JavaType	type	The type of the field
protected String	value	The value assigned to the field
protected Visibility	visibility	The Visibility of the field

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, TYPE_PARAMETER_CLOSE_TOKEN, TYPE_PARAMETER_OPEN_TOKEN, VARARGS_TOKEN, VISIBILITY_MODIFIERS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JavaField(boolean editable, Javadoc javadoc, List<JavaAnnotation> annotations, Visibility visibility, boolean isStatic, boolean isFinal, JavaType type, String name, String value)	Constructs a Java Field with the given parameters

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object otherField)
List<JavaAnnotation>	getAnnotations()
JavaCodeTypes	getJavaCodeType()
Javadoc	getJavadoc()
String	getName()
JavaType	getType()
String	getValue()
Visibility	getVisibility()
boolean	isEditable()
boolean	isFinal()
boolean	isStatic()
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

javadoc

protected Javadoc javadoc

The Javadoc on the field

annotations

protected List<JavaAnnotation> annotations

The annotations on the field

visibility

protected Visibility visibility

The Visibility of the field

isStatic

protected boolean isStatic

Whether the field is static or not

isFinal

protected boolean isFinal

Whether the field is final or not

type

protected JavaType type

The type of the field

name

protected String name

The name of the field

value

protected String value

The value assigned to the field

Constructor Details

JavaField

protected JavaField(boolean editable,
 Javadoc javadoc,
 List<JavaAnnotation> annotations,
 Visibility visibility,
 boolean isStatic,
 boolean isFinal,
 JavaType type,
 String name,
 String value)

Constructs a Java Field with the given parameters

Parameters:

editable - Whether the field is editable or not

javadoc - The Javadoc on the field

annotations - The annotations on the field

visibility - The Visibility of the field

isStatic - Whether the field is static or not

isFinal - Whether the field is final or not

type - The type of the field

name - The name of the field

value - The value assigned to the field

Method Details

getJavaCodeType

public JavaCodeTypes getJavaCodeType()

Specified by:

getJavaCodeType in interface JavaCodeType

Returns:

What type this is

isEditable

public boolean isEditable()

Returns:

Whether the field is editable or not

getJavadoc

public Javadoc getJavadoc()

Returns:

The Javadoc on the field

getAnnotations

public List<JavaAnnotation> getAnnotations()

Returns:

The annotations on the field

getVisibility

public Visibility getVisibility()

Returns:

The Visibility of the field

isStatic

public boolean isStatic()

Returns:

Whether the field is static or not

isFinal

public boolean isFinal()

Returns:

Whether the field is final or not

getType

public JavaType getType()

Returns:

The type of the field

getName

public String getName()

Returns:

The name of the field

getValue

public String getValue()

Returns:

The value assigned to the field

toString

public String toString()

Overrides:

toString in class Object

Returns:

A string of the form "{visibility.getText()} {type} {name}", with javadoc and annotations on newlines above

equals

public boolean equals(Object otherField)

Overrides:

equals in class Object

toBuilderCode

public String toBuilderCode()

Specified by:

toBuilderCode in interface JavaCodeType

Returns:

The String of code to build the JavaCodeType