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

Class JavaMethod.JavaMethodBuilder

java.lang.Object

com.github.tadukoo.parsing.code.java.JavaMethod.JavaMethodBuilder

Enclosing class:

JavaMethod

public static class JavaMethod.JavaMethodBuilder
extends Object

Java Method Builder is used to build a new JavaMethod. It contains the following parameters:

Java Method Parameters

Parameter	Description	Default or Required
annotations	The annotations on the method	An empty list
visibility	The Visibility of the method	Visibility.PUBLIC
returnType	The return type of the method	Required
name	The name of the method	null (used for constructors)
parameters	The parameters used in the method - pairs of type, then name	An empty list
throwTypes	The types that can be thrown by the method	An empty list
lines	The actual lines of code in the method	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 method
private List<String>	lines	The actual lines of code in the method
private String	name	The name of the method
private List<com.github.tadukoo.util.tuple.Pair<String,String>>	parameters	The parameters used in the method - pairs of type, then name
private String	returnType	The return type of the method
private List<String>	throwTypes	The types that can be thrown by the method
private Visibility	visibility	The Visibility of the method

Constructor Summary

Constructors

Modifier	Constructor	Description
private	JavaMethodBuilder()

Method Summary

Modifier and Type	Method	Description
JavaMethod.JavaMethodBuilder	annotation(JavaAnnotation annotation)
JavaMethod.JavaMethodBuilder	annotations(List<JavaAnnotation> annotations)
JavaMethod	build()	Checks for any errors in the current parameters, then builds a new JavaMethod
private void	checkForErrors()	Checks for any errors in the current parameters
JavaMethod.JavaMethodBuilder	line(String line)
JavaMethod.JavaMethodBuilder	lines(List<String> lines)
JavaMethod.JavaMethodBuilder	name(String name)
JavaMethod.JavaMethodBuilder	parameter(com.github.tadukoo.util.tuple.Pair<String,String> parameter)
JavaMethod.JavaMethodBuilder	parameter(String type, String name)
JavaMethod.JavaMethodBuilder	parameters(List<com.github.tadukoo.util.tuple.Pair<String,String>> parameters)
JavaMethod.JavaMethodBuilder	returnType(String returnType)
JavaMethod.JavaMethodBuilder	throwType(String throwType)
JavaMethod.JavaMethodBuilder	throwTypes(List<String> throwTypes)
JavaMethod.JavaMethodBuilder	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 method

visibility

private Visibility visibility

The Visibility of the method

returnType

private String returnType

The return type of the method

name

private String name

The name of the method

parameters

private List<com.github.tadukoo.util.tuple.Pair<String,String>> parameters

The parameters used in the method - pairs of type, then name

throwTypes

private List<String> throwTypes

The types that can be thrown by the method

lines

private List<String> lines

The actual lines of code in the method

Constructor Details

JavaMethodBuilder

private JavaMethodBuilder()

Method Details

annotations

public JavaMethod.JavaMethodBuilder annotations(List<JavaAnnotation> annotations)

Parameters:

annotations - The annotations on the method

Returns:

this, to continue building

annotation

public JavaMethod.JavaMethodBuilder annotation(JavaAnnotation annotation)

Parameters:

annotation - A single annotation on the method

Returns:

this, to continue building

visibility

public JavaMethod.JavaMethodBuilder visibility(Visibility visibility)

Parameters:

visibility - The Visibility of the method

Returns:

this, to continue building

returnType

public JavaMethod.JavaMethodBuilder returnType(String returnType)

Parameters:

returnType - The return type of the method

Returns:

this, to continue building

name

public JavaMethod.JavaMethodBuilder name(String name)

Parameters:

name - The name of the method

Returns:

this, to continue building

parameters

public JavaMethod.JavaMethodBuilder parameters(List<com.github.tadukoo.util.tuple.Pair<String,String>> parameters)

Parameters:

parameters - The parameters used in the method - pairs of type, then name

Returns:

this, to continue building

parameter

public JavaMethod.JavaMethodBuilder parameter(com.github.tadukoo.util.tuple.Pair<String,String> parameter)

Parameters:

parameter - A single parameter, with type first, then name - to add to the list

Returns:

this, to continue building

parameter

public JavaMethod.JavaMethodBuilder parameter(String type,
 String name)

Parameters:

type - The type of the parameter to be added

name - The name of the parameter to be added

Returns:

this, to continue building

throwTypes

public JavaMethod.JavaMethodBuilder throwTypes(List<String> throwTypes)

Parameters:

throwTypes - The types the method can throw

Returns:

this, to continue building

throwType

public JavaMethod.JavaMethodBuilder throwType(String throwType)

Parameters:

throwType - A type the method can throw - to add to the list

Returns:

this, to continue building

lines

public JavaMethod.JavaMethodBuilder lines(List<String> lines)

Parameters:

lines - The actual lines of code in the method

Returns:

this, to continue building

line

public JavaMethod.JavaMethodBuilder line(String line)

Parameters:

line - A single line of code in the method, to add 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 JavaMethod build()

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

Returns:

A newly built JavaMethod

Throws:

IllegalArgumentException - if anything is wrong with the current parameters