Package com.github.tadukoo.java.field

Class JavaFieldBuilder<FieldType extends JavaField>

java.lang.Object

com.github.tadukoo.java.field.JavaFieldBuilder<FieldType>

Direct Known Subclasses:

EditableJavaField.EditableJavaFieldBuilder, UneditableJavaField.UneditableJavaFieldBuilder

public abstract class JavaFieldBuilder<FieldType extends JavaField>
extends Object

Java Field Builder is a builder to create a JavaField. It has the following parameters:

Java Field Parameters

Parameter	Description	Default or Required
javadoc	The Javadoc on the field	null
annotations	The annotations on the field	An empty list
visibility	The Visibility of the field	Visibility.NONE
isStatic	If the field is static or not	false
isFinal	If the field is final or not	false
type	The type of the field	Required
name	The name of the field	Required
value	The value assigned to the field	null

Since:

Alpha v.0.2 (within JavaField), Alpha v.0.4 (as separate)

Version:

Beta v.0.5

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 String	type	The type of the field
protected String	value	The value assigned to the field
protected Visibility	visibility	The Visibility of the field

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JavaFieldBuilder()	Constructs a new JavaFieldBuilder

Method Summary

Modifier and Type	Method	Description
JavaFieldBuilder<FieldType>	annotation(JavaAnnotation annotation)
JavaFieldBuilder<FieldType>	annotations(List<JavaAnnotation> annotations)
FieldType	build()	Checks for any errors in the current parameters, then builds a new JavaField
protected abstract List<String>	checkForSpecificErrors()	Checks for errors specific to the subclass
protected abstract FieldType	constructField()	Constructs a JavaField using the set parameters
JavaFieldBuilder<FieldType>	copy(JavaField field)	Copies the settings from the given field to this builder
JavaFieldBuilder<FieldType>	isFinal()	Sets the field to be final
JavaFieldBuilder<FieldType>	isFinal(boolean isFinal)
JavaFieldBuilder<FieldType>	isStatic()	Sets the field to be static
JavaFieldBuilder<FieldType>	isStatic(boolean isStatic)
JavaFieldBuilder<FieldType>	javadoc(Javadoc javadoc)
JavaFieldBuilder<FieldType>	name(String name)
JavaFieldBuilder<FieldType>	type(String type)
JavaFieldBuilder<FieldType>	value(String value)
JavaFieldBuilder<FieldType>	visibility(Visibility visibility)

Methods inherited from class java.lang.Object

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

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 String 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

JavaFieldBuilder

protected JavaFieldBuilder()

Constructs a new JavaFieldBuilder

Method Details

copy

public JavaFieldBuilder<FieldType> copy(JavaField field)

Copies the settings from the given field to this builder

Parameters:

field - The field to copy settings from

Returns:

this, to continue building

javadoc

public JavaFieldBuilder<FieldType> javadoc(Javadoc javadoc)

Parameters:

javadoc - The Javadoc on the field

Returns:

this, to continue building

annotations

public JavaFieldBuilder<FieldType> annotations(List<JavaAnnotation> annotations)

Parameters:

annotations - The annotations on the field

Returns:

this, to continue building

annotation

public JavaFieldBuilder<FieldType> annotation(JavaAnnotation annotation)

Parameters:

annotation - A single annotation on the field

Returns:

this, to continue building

visibility

public JavaFieldBuilder<FieldType> visibility(Visibility visibility)

Parameters:

visibility - The Visibility of the field

Returns:

this, to continue building

isStatic

public JavaFieldBuilder<FieldType> isStatic()

Sets the field to be static

Returns:

this, to continue building

isStatic

public JavaFieldBuilder<FieldType> isStatic(boolean isStatic)

Parameters:

isStatic - Whether the field is static or not

Returns:

this, to continue building

isFinal

public JavaFieldBuilder<FieldType> isFinal()

Sets the field to be final

Returns:

this, to continue building

isFinal

public JavaFieldBuilder<FieldType> isFinal(boolean isFinal)

Parameters:

isFinal - Whether the field is final or not

Returns:

this, to continue building

type

public JavaFieldBuilder<FieldType> type(String type)

Parameters:

type - The type of the field

Returns:

this, to continue building

name

public JavaFieldBuilder<FieldType> name(String name)

Parameters:

name - The name of the field

Returns:

this, to continue building

value

public JavaFieldBuilder<FieldType> value(String value)

Parameters:

value - The value assigned to the field

Returns:

this, to continue building

checkForSpecificErrors

protected abstract List<String> checkForSpecificErrors()

Checks for errors specific to the subclass

Returns:

The errors found in the subclass, or an empty List

build

public FieldType build()

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

Returns:

A newly built JavaField

Throws:

IllegalArgumentException - if anything is wrong with the current parameters

constructField

protected abstract FieldType constructField()

Constructs a JavaField using the set parameters

Returns:

The newly built JavaField