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

Class JavaClass.JavaClassBuilder

java.lang.Object

com.github.tadukoo.parsing.code.java.JavaClass.JavaClassBuilder

Enclosing class:

JavaClass

public static class JavaClass.JavaClassBuilder
extends Object

Java Class Builder is used to create a JavaClass. It has the following parameters:

Java Class Parameters

Parameter	Description	Default or Required
packageName	The name of the package the class is in	Required
imports	The classes imported by the class	An empty list
staticImports	The classes imported statically by the class	An empty list
annotations	The annotations on the class	An empty list
visibility	The Visibility of the class	Visibility.PUBLIC
className	The name of the class	Required
superClassName	The name of the class this one extends (may be null)	null
fields	The fields on the class	An empty list
methods	The methods in the class	An empty list

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 class
private String	className	The name of the class
private List<JavaField>	fields	The fields on the class
private List<String>	imports	The classes imported by the class
private List<JavaMethod>	methods	The methods in the class
private String	packageName	The name of the package the class is in
private List<String>	staticImports	The classes imported statically by the class
private String	superClassName	The name of the class this one extends (may be null)
private Visibility	visibility	The Visibility of the class

Constructor Summary

Constructors

Modifier	Constructor	Description
private	JavaClassBuilder()

Method Summary

Modifier and Type	Method	Description
JavaClass.JavaClassBuilder	annotation(JavaAnnotation annotation)
JavaClass.JavaClassBuilder	annotations(List<JavaAnnotation> annotations)
JavaClass	build()	Checks for any errors in the current parameters, then builds a new JavaClass
private void	checkForErrors()	Checks for any errors in the current parameters
JavaClass.JavaClassBuilder	className(String className)
JavaClass.JavaClassBuilder	field(JavaField field)
JavaClass.JavaClassBuilder	fields(List<JavaField> fields)
JavaClass.JavaClassBuilder	imports(List<String> imports)
JavaClass.JavaClassBuilder	method(JavaMethod method)
JavaClass.JavaClassBuilder	methods(List<JavaMethod> methods)
JavaClass.JavaClassBuilder	packageName(String packageName)
JavaClass.JavaClassBuilder	singleImport(String singleImport)
JavaClass.JavaClassBuilder	staticImport(String staticImport)
JavaClass.JavaClassBuilder	staticImports(List<String> staticImports)
JavaClass.JavaClassBuilder	superClassName(String superClassName)
JavaClass.JavaClassBuilder	visibility(Visibility visibility)

Methods inherited from class java.lang.Object

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

Field Details

packageName

private String packageName

The name of the package the class is in

imports

private List<String> imports

The classes imported by the class

staticImports

private List<String> staticImports

The classes imported statically by the class

annotations

private List<JavaAnnotation> annotations

The annotations on the class

visibility

private Visibility visibility

The Visibility of the class

className

private String className

The name of the class

superClassName

private String superClassName

The name of the class this one extends (may be null)

fields

private List<JavaField> fields

The fields on the class

methods

private List<JavaMethod> methods

The methods in the class

Constructor Details

JavaClassBuilder

private JavaClassBuilder()

Method Details

packageName

public JavaClass.JavaClassBuilder packageName(String packageName)

Parameters:

packageName - The name of the package the class is in

Returns:

this, to continue building

imports

public JavaClass.JavaClassBuilder imports(List<String> imports)

Parameters:

imports - The classes imported by the class

Returns:

this, to continue building

singleImport

public JavaClass.JavaClassBuilder singleImport(String singleImport)

Parameters:

singleImport - A single class imported by the class, to be added to the list

Returns:

this, to continue building

staticImports

public JavaClass.JavaClassBuilder staticImports(List<String> staticImports)

Parameters:

staticImports - The classes imported statically by the class

Returns:

this, to continue building

staticImport

public JavaClass.JavaClassBuilder staticImport(String staticImport)

Parameters:

staticImport - A single class imported statically by the class, to be added to the list

Returns:

this, to continue building

annotations

public JavaClass.JavaClassBuilder annotations(List<JavaAnnotation> annotations)

Parameters:

annotations - The annotations on the class

Returns:

this, to continue building

annotation

public JavaClass.JavaClassBuilder annotation(JavaAnnotation annotation)

Parameters:

annotation - A single annotation on the class

Returns:

this, to continue building

visibility

public JavaClass.JavaClassBuilder visibility(Visibility visibility)

Parameters:

visibility - The Visibility of the class

Returns:

this, to continue building

className

public JavaClass.JavaClassBuilder className(String className)

Parameters:

className - The name of the class

Returns:

this, to continue building

superClassName

public JavaClass.JavaClassBuilder superClassName(String superClassName)

Parameters:

superClassName - The name of the class this one extends (may be null)

Returns:

this, to continue building

fields

public JavaClass.JavaClassBuilder fields(List<JavaField> fields)

Parameters:

fields - The fields on the class

Returns:

this, to continue building

field

public JavaClass.JavaClassBuilder field(JavaField field)

Parameters:

field - A field on the class, to be added to the list

Returns:

this, to continue building

methods

public JavaClass.JavaClassBuilder methods(List<JavaMethod> methods)

Parameters:

methods - The methods in the class

Returns:

this, to continue building

method

public JavaClass.JavaClassBuilder method(JavaMethod method)

Parameters:

method - A method in the class, to be added to the list

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 JavaClass build()

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

Returns:

A newly built JavaClass

Throws:

IllegalArgumentException - if anything is wrong with the current parameters