Package com.github.tadukoo.java.javaclass

Class JavaClass

java.lang.Object

com.github.tadukoo.java.javaclass.JavaClass

All Implemented Interfaces:

JavaClassType, JavaCodeType, JavaTokens

Direct Known Subclasses:

EditableJavaClass, UneditableJavaClass

public abstract class JavaClass
extends Object
implements JavaClassType

Java Class is used to represent a class in Java.

Since:

Alpha v.0.2 (as old version that is now more like UneditableJavaClass), Alpha v.0.4 (as newer version)

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 class
protected String	className	The name of the class
protected List<JavaField>	fields	The fields on the class
protected List<String>	implementsInterfaceNames	The names of interfaces this class implements
protected List<JavaImportStatement>	importStatements	The import statements of the class
protected List<JavaClass>	innerClasses	Inner classes inside the class
protected List<com.github.tadukoo.util.tuple.Pair<JavaCodeTypes,String>>	innerElementsOrder	The order of the elements inside the class
protected boolean	isAbstract	Whether this is an abstract class or not
protected boolean	isFinal	Whether this is a final class or not
protected boolean	isInnerClass	Whether this is an inner class or not
protected boolean	isStatic	Whether this is a static class or not
protected Javadoc	javadoc	The Javadoc for the class
protected List<JavaMethod>	methods	The methods in the class
protected List<JavaMultiLineComment>	multiLineComments	The multi-line comments inside the class
protected JavaPackageDeclaration	packageDeclaration	The package declaration of the class
protected List<JavaSingleLineComment>	singleLineComments	The single-line comments inside the class
protected String	superClassName	The name of the class this one extends (may be null)
protected Visibility	visibility	The Visibility of the class

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JavaClass(boolean editable, boolean isInnerClass, JavaPackageDeclaration packageDeclaration, List<JavaImportStatement> importStatements, Javadoc javadoc, List<JavaAnnotation> annotations, Visibility visibility, boolean isAbstract, boolean isStatic, boolean isFinal, String className, String superClassName, List<String> implementsInterfaceNames, List<JavaSingleLineComment> singleLineComments, List<JavaMultiLineComment> multiLineComments, List<JavaClass> innerClasses, List<JavaField> fields, List<JavaMethod> methods, List<com.github.tadukoo.util.tuple.Pair<JavaCodeTypes,String>> innerElementsOrder)	Constructs a new Java Class with the given parameters

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object otherClass)
List<JavaAnnotation>	getAnnotations()
String	getClassName()
List<JavaField>	getFields()
Map<String,JavaField>	getFieldsMap()
List<String>	getImplementsInterfaceNames()
List<JavaImportStatement>	getImportStatements()
List<JavaClass>	getInnerClasses()
Map<String,JavaClass>	getInnerClassesMap()
List<com.github.tadukoo.util.tuple.Pair<JavaCodeTypes,String>>	getInnerElementsOrder()
JavaCodeTypes	getJavaCodeType()
Javadoc	getJavadoc()
List<JavaMethod>	getMethods()
Map<String,JavaMethod>	getMethodsMap()
List<JavaMultiLineComment>	getMultiLineComments()
JavaPackageDeclaration	getPackageDeclaration()
List<JavaSingleLineComment>	getSingleLineComments()
String	getSuperClassName()
Visibility	getVisibility()
boolean	isAbstract()
boolean	isEditable()
boolean	isFinal()
boolean	isInnerClass()
boolean	isStatic()
String	toBuilderCode()
String	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

Field Details

isInnerClass

protected boolean isInnerClass

Whether this is an inner class or not

packageDeclaration

protected JavaPackageDeclaration packageDeclaration

The package declaration of the class

importStatements

protected List<JavaImportStatement> importStatements

The import statements of the class

javadoc

protected Javadoc javadoc

The Javadoc for the class

annotations

protected List<JavaAnnotation> annotations

The annotations on the class

visibility

protected Visibility visibility

The Visibility of the class

isAbstract

protected boolean isAbstract

Whether this is an abstract class or not

isStatic

protected boolean isStatic

Whether this is a static class or not

isFinal

protected boolean isFinal

Whether this is a final class or not

className

protected String className

The name of the class

superClassName

protected String superClassName

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

implementsInterfaceNames

protected List<String> implementsInterfaceNames

The names of interfaces this class implements

singleLineComments

protected List<JavaSingleLineComment> singleLineComments

The single-line comments inside the class

multiLineComments

protected List<JavaMultiLineComment> multiLineComments

The multi-line comments inside the class

innerClasses

protected List<JavaClass> innerClasses

Inner classes inside the class

fields

protected List<JavaField> fields

The fields on the class

methods

protected List<JavaMethod> methods

The methods in the class

innerElementsOrder

protected List<com.github.tadukoo.util.tuple.Pair<JavaCodeTypes,String>> innerElementsOrder

The order of the elements inside the class

Constructor Details

JavaClass

protected JavaClass(boolean editable,
 boolean isInnerClass,
 JavaPackageDeclaration packageDeclaration,
 List<JavaImportStatement> importStatements,
 Javadoc javadoc,
 List<JavaAnnotation> annotations,
 Visibility visibility,
 boolean isAbstract,
 boolean isStatic,
 boolean isFinal,
 String className,
 String superClassName,
 List<String> implementsInterfaceNames,
 List<JavaSingleLineComment> singleLineComments,
 List<JavaMultiLineComment> multiLineComments,
 List<JavaClass> innerClasses,
 List<JavaField> fields,
 List<JavaMethod> methods,
 List<com.github.tadukoo.util.tuple.Pair<JavaCodeTypes,String>> innerElementsOrder)

Constructs a new Java Class with the given parameters

Parameters:

editable - Whether this class is editable or not

isInnerClass - Whether this is an inner class or not

packageDeclaration - The package declaration of the class

importStatements - The import statements of the class

javadoc - The Javadoc for the class

annotations - The annotations on the class

visibility - The Visibility of the class

isAbstract - Whether this is an abstract class or not

isStatic - Whether this is a static class or not

isFinal - Whether this is a final class or not

className - The name of the class

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

implementsInterfaceNames - The names of interfaces this class implements

singleLineComments - The single-line comments inside the class

multiLineComments - The multi-line comments inside the class

innerClasses - Inner classes inside the class

fields - The fields on the class

methods - The methods in the class

innerElementsOrder - The order of the elements inside the class

Method Details

getJavaCodeType

public JavaCodeTypes getJavaCodeType()

Specified by:

getJavaCodeType in interface JavaCodeType

Returns:

What type this is

isEditable

public boolean isEditable()

Returns:

Whether this class is editable or not

isInnerClass

public boolean isInnerClass()

Returns:

Whether this is an inner class or not

getPackageDeclaration

public JavaPackageDeclaration getPackageDeclaration()

Returns:

The package declaration of the class

getImportStatements

public List<JavaImportStatement> getImportStatements()

Returns:

The import statements of the class

getJavadoc

public Javadoc getJavadoc()

Returns:

The Javadoc for the class

getAnnotations

public List<JavaAnnotation> getAnnotations()

Returns:

The annotations on the class

getVisibility

public Visibility getVisibility()

Returns:

The Visibility of the class

isAbstract

public boolean isAbstract()

Returns:

Whether this class is abstract or not

isStatic

public boolean isStatic()

Returns:

Whether this class is static or not

isFinal

public boolean isFinal()

Returns:

Whether this class is final or not

getClassName

public String getClassName()

Returns:

The name of the class

getSuperClassName

public String getSuperClassName()

Returns:

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

getImplementsInterfaceNames

public List<String> getImplementsInterfaceNames()

Returns:

The names of interfaces this class implements

getSingleLineComments

public List<JavaSingleLineComment> getSingleLineComments()

Returns:

The single-line comments inside this class

getMultiLineComments

public List<JavaMultiLineComment> getMultiLineComments()

Returns:

The multi-line comments inside this class

getInnerClasses

public List<JavaClass> getInnerClasses()

Returns:

Inner classes inside this class

getInnerClassesMap

public Map<String,JavaClass> getInnerClassesMap()

Returns:

The classes inside this class as a Map by class name

getFields

public List<JavaField> getFields()

Returns:

The fields on the class

getFieldsMap

public Map<String,JavaField> getFieldsMap()

Returns:

The fields on the class as a Map by field name

getMethods

public List<JavaMethod> getMethods()

Returns:

The methods in the class

getMethodsMap

public Map<String,JavaMethod> getMethodsMap()

Returns:

The methods on the class as a Map by method name (using JavaMethod.getUniqueName())

getInnerElementsOrder

public List<com.github.tadukoo.util.tuple.Pair<JavaCodeTypes,String>> getInnerElementsOrder()

Returns:

The order of elements inside the class

toString

public String toString()

Overrides:

toString in class Object

Returns:

The actual Java code this JavaClass represents

equals

public boolean equals(Object otherClass)

Overrides:

equals in class Object

toBuilderCode

public String toBuilderCode()

Specified by:

toBuilderCode in interface JavaCodeType

Returns:

The String of code to build the JavaCodeType