Package com.github.tadukoo.parsing.code.java

Class JavaField.JavaFieldBuilder

java.lang.Object

com.github.tadukoo.parsing.code.java.JavaField.JavaFieldBuilder

Enclosing class:

JavaField

public static class JavaField.JavaFieldBuilder
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
annotations	The annotations on the field	An empty list
visibility	The Visibility of the field	Visibility.PRIVATE
final	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

Version:

Alpha v.0.3

Author:

Logan Ferree (Tadukoo)

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
private	JavaFieldBuilder()

Method Summary

Modifier and Type	Method	Description
JavaField.JavaFieldBuilder	annotation(JavaAnnotation annotation)
JavaField.JavaFieldBuilder	annotations(List<JavaAnnotation> annotations)
JavaField	build()	Checks for any errors in the current parameters, then builds a new JavaField
private void	checkForErrors()	Checks for any errors in the current parameters
JavaField.JavaFieldBuilder	isFinal()	Sets the field to be final
JavaField.JavaFieldBuilder	isFinal(boolean isFinal)
JavaField.JavaFieldBuilder	name(String name)
JavaField.JavaFieldBuilder	type(String type)
JavaField.JavaFieldBuilder	value(String value)
JavaField.JavaFieldBuilder	visibility(Visibility visibility)

Methods inherited from class java.lang.Object

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

Field Details

annotations

private List<JavaAnnotation> annotations

The annotations on the field

visibility

private Visibility visibility

The Visibility of the field

isFinal

private boolean isFinal

Whether the field is final or not

type

private String type

The type of the field

name

private String name

The name of the field

value

private String value

The value assigned to the field

Constructor Details

JavaFieldBuilder

private JavaFieldBuilder()

Method Details

annotations

public JavaField.JavaFieldBuilder annotations(List<JavaAnnotation> annotations)

Parameters:

annotations - The annotations on the field

Returns:

this, to continue building

annotation

public JavaField.JavaFieldBuilder annotation(JavaAnnotation annotation)

Parameters:

annotation - A single annotation on the field

Returns:

this, to continue building

visibility

public JavaField.JavaFieldBuilder visibility(Visibility visibility)

Parameters:

visibility - The Visibility of the field

Returns:

this, to continue building

isFinal

public JavaField.JavaFieldBuilder isFinal()

Sets the field to be final

Returns:

this, to continue building

isFinal

public JavaField.JavaFieldBuilder isFinal(boolean isFinal)

Parameters:

isFinal - Whether the field is final or not

Returns:

this, to continue building

type

public JavaField.JavaFieldBuilder type(String type)

Parameters:

type - The type of the field

Returns:

this, to continue building

name

public JavaField.JavaFieldBuilder name(String name)

Parameters:

name - The name of the field

Returns:

this, to continue building

value

public JavaField.JavaFieldBuilder value(String value)

Parameters:

value - The value assigned to the field

Returns:

this, to continue building

checkForErrors

private void checkForErrors()

Checks for any errors in the current parameters

Throws:

IllegalArgumentException - if anything is wrong

build

public JavaField 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