Package com.github.tadukoo.java.method

Class EditableJavaMethod

java.lang.Object

com.github.tadukoo.java.method.JavaMethod

com.github.tadukoo.java.method.EditableJavaMethod

All Implemented Interfaces:

JavaCodeType, JavaTokens

public class EditableJavaMethod
extends JavaMethod

Represents a method in Java that can be modified

Since:

Alpha v.0.4

Version:

Beta v.0.5

Author:

Logan Ferree (Tadukoo)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EditableJavaMethod.EditableJavaMethodBuilder	A builder used to make an EditableJavaMethod

Field Summary

Fields inherited from class com.github.tadukoo.java.method.JavaMethod

annotations, isAbstract, isFinal, isStatic, javadoc, lines, name, parameters, returnType, throwTypes, visibility

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, VISIBILITY_MODIFIERS

Method Summary

Modifier and Type	Method	Description
void	addAnnotation(JavaAnnotation annotation)
void	addAnnotations(List<JavaAnnotation> annotations)
void	addLine(String line)
void	addLines(List<String> lines)
void	addParameter(com.github.tadukoo.util.tuple.Pair<String,String> parameter)
void	addParameter(String type, String name)
void	addParameters(List<com.github.tadukoo.util.tuple.Pair<String,String>> parameters)
void	addThrowType(String throwType)
void	addThrowTypes(List<String> throwTypes)
static EditableJavaMethod.EditableJavaMethodBuilder	builder()
void	setAbstract(boolean isAbstract)
void	setAnnotations(List<JavaAnnotation> annotations)
void	setFinal(boolean isFinal)
void	setJavadoc(Javadoc javadoc)
void	setLines(List<String> lines)
void	setName(String name)
void	setParameters(List<com.github.tadukoo.util.tuple.Pair<String,String>> parameters)
void	setReturnType(String returnType)
void	setStatic(boolean isStatic)
void	setThrowTypes(List<String> throwTypes)
void	setVisibility(Visibility visibility)

Methods inherited from class com.github.tadukoo.java.method.JavaMethod

equals, getAnnotations, getJavaCodeType, getJavadoc, getLines, getName, getParameters, getReturnType, getThrowTypes, getUniqueName, getVisibility, isAbstract, isEditable, isFinal, isStatic, toBuilderCode, 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

Method Details

builder

public static EditableJavaMethod.EditableJavaMethodBuilder builder()

Returns:

A new EditableJavaMethod.EditableJavaMethodBuilder to use to build a new EditableJavaMethod

setJavadoc

public void setJavadoc(Javadoc javadoc)

Parameters:

javadoc - The Javadoc on the method

addAnnotation

public void addAnnotation(JavaAnnotation annotation)

Parameters:

annotation - An annotation on the method to be added - must be editable

addAnnotations

public void addAnnotations(List<JavaAnnotation> annotations)

Parameters:

annotations - annotations on the method to be added - must be editable

setAnnotations

public void setAnnotations(List<JavaAnnotation> annotations)

Parameters:

annotations - The annotations on the method - must be editable

setVisibility

public void setVisibility(Visibility visibility)

Parameters:

visibility - The Visibility of the method

setAbstract

public void setAbstract(boolean isAbstract)

Parameters:

isAbstract - Whether the method is abstract or not

setStatic

public void setStatic(boolean isStatic)

Parameters:

isStatic - Whether the method is static or not

setFinal

public void setFinal(boolean isFinal)

Parameters:

isFinal - Whether the method is final or not

setReturnType

public void setReturnType(String returnType)

Parameters:

returnType - The return type of the method

setName

public void setName(String name)

Parameters:

name - The name of the method

addParameter

public void addParameter(String type,
 String name)

Parameters:

type - The type of the parameter used in the method to be added

name - The name of the parameter used in the method to be added

addParameter

public void addParameter(com.github.tadukoo.util.tuple.Pair<String,String> parameter)

Parameters:

parameter - A parameter used in the method to be added - a pair of type, then name

addParameters

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

Parameters:

parameters - Parameters used in the method to be added - pairs of type, then name

setParameters

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

Parameters:

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

addThrowType

public void addThrowType(String throwType)

Parameters:

throwType - A type that can be thrown to add to the method

addThrowTypes

public void addThrowTypes(List<String> throwTypes)

Parameters:

throwTypes - Types that can be thrown to add to the method

setThrowTypes

public void setThrowTypes(List<String> throwTypes)

Parameters:

throwTypes - The types that can be thrown by the method

addLine

public void addLine(String line)

Parameters:

line - An actual line of code to add to the method

addLines

public void addLines(List<String> lines)

Parameters:

lines - Actual lines of code to add to the method

setLines

public void setLines(List<String> lines)

Parameters:

lines - The actual lines of code in the method