org.mybatis.generator.api.dom.java

Class TopLevelEnumeration

java.lang.Object

org.mybatis.generator.api.dom.java.JavaElement

org.mybatis.generator.api.dom.java.InnerEnum

org.mybatis.generator.api.dom.java.TopLevelEnumeration

All Implemented Interfaces:

CompilationUnit

public class TopLevelEnumeration
extends InnerEnum
implements CompilationUnit

The Class TopLevelEnumeration.

Author:

Jeff Butler

Constructor Summary

Constructors

Constructor and Description
TopLevelEnumeration(FullyQualifiedJavaType type) Instantiates a new top level enumeration.

Method Summary

Modifier and Type	Method and Description
void	addFileCommentLine(String commentLine) Comments will be written at the top of the file as is, we do not append any start or end comment characters.
void	addImportedType(FullyQualifiedJavaType importedType) Adds the imported type.
void	addImportedTypes(Set<FullyQualifiedJavaType> importedTypes) Adds the imported types.
void	addStaticImport(String staticImport) Adds the static import.
void	addStaticImports(Set<String> staticImports) Adds the static imports.
List<String>	getFileCommentLines() Gets the file comment lines.
String	getFormattedContent() Gets the formatted content.
Set<FullyQualifiedJavaType>	getImportedTypes() Gets the imported types.
Set<String>	getStaticImports() Gets the static imports.
FullyQualifiedJavaType	getSuperClass() Gets the super class.
boolean	isJavaEnumeration() Checks if is java enumeration.
boolean	isJavaInterface() Checks if is java interface.

Methods inherited from class org.mybatis.generator.api.dom.java.InnerEnum

addEnumConstant, addField, addInnerClass, addInnerEnum, addMethod, addSuperInterface, getEnumConstants, getFields, getFormattedContent, getInnerClasses, getInnerEnums, getMethods, getSuperInterfaceTypes, getType

Methods inherited from class org.mybatis.generator.api.dom.java.JavaElement

addAnnotation, addFormattedAnnotations, addFormattedJavadoc, addJavaDocLine, addSuppressTypeWarningsAnnotation, getAnnotations, getJavaDocLines, getVisibility, isFinal, isStatic, setFinal, setStatic, setVisibility

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mybatis.generator.api.dom.java.CompilationUnit

getSuperInterfaceTypes, getType

Constructor Detail

TopLevelEnumeration

public TopLevelEnumeration(FullyQualifiedJavaType type)

Instantiates a new top level enumeration.

Parameters:

type - the type

Method Detail

getFormattedContent

public String getFormattedContent()

Description copied from interface: CompilationUnit

Gets the formatted content.

Specified by:

getFormattedContent in interface CompilationUnit

Returns:

the formatted content

getImportedTypes

public Set<FullyQualifiedJavaType> getImportedTypes()

Description copied from interface: CompilationUnit

Gets the imported types.

Specified by:

getImportedTypes in interface CompilationUnit

Returns:

the imported types

getSuperClass

public FullyQualifiedJavaType getSuperClass()

Description copied from interface: CompilationUnit

Gets the super class.

Specified by:

getSuperClass in interface CompilationUnit

Returns:

the super class

isJavaInterface

public boolean isJavaInterface()

Description copied from interface: CompilationUnit

Checks if is java interface.

Specified by:

isJavaInterface in interface CompilationUnit

Returns:

true, if is java interface

isJavaEnumeration

public boolean isJavaEnumeration()

Description copied from interface: CompilationUnit

Checks if is java enumeration.

Specified by:

isJavaEnumeration in interface CompilationUnit

Returns:

true, if is java enumeration

addImportedType

public void addImportedType(FullyQualifiedJavaType importedType)

Description copied from interface: CompilationUnit

Adds the imported type.

Specified by:

addImportedType in interface CompilationUnit

Parameters:

importedType - the imported type

addFileCommentLine

public void addFileCommentLine(String commentLine)

Description copied from interface: CompilationUnit

Comments will be written at the top of the file as is, we do not append any start or end comment characters. Note that in the Eclipse plugin, file comments will not be merged.

Specified by:

addFileCommentLine in interface CompilationUnit

Parameters:

commentLine - the comment line

getFileCommentLines

public List<String> getFileCommentLines()

Description copied from interface: CompilationUnit

Gets the file comment lines.

Specified by:

getFileCommentLines in interface CompilationUnit

Returns:

the file comment lines

addImportedTypes

public void addImportedTypes(Set<FullyQualifiedJavaType> importedTypes)

Description copied from interface: CompilationUnit

Adds the imported types.

Specified by:

addImportedTypes in interface CompilationUnit

Parameters:

importedTypes - the imported types

getStaticImports

public Set<String> getStaticImports()

Description copied from interface: CompilationUnit

Gets the static imports.

Specified by:

getStaticImports in interface CompilationUnit

Returns:

the static imports

addStaticImport

public void addStaticImport(String staticImport)

Description copied from interface: CompilationUnit

Adds the static import.

Specified by:

addStaticImport in interface CompilationUnit

Parameters:

staticImport - the static import

addStaticImports

public void addStaticImports(Set<String> staticImports)

Description copied from interface: CompilationUnit

Adds the static imports.

Specified by:

addStaticImports in interface CompilationUnit

Parameters:

staticImports - the static imports