Class AbstractJClassDef

java.lang.Object

org.jboss.jdeparser.BasicJCommentable

org.jboss.jdeparser.AbstractJDocCommentable

org.jboss.jdeparser.BasicJAnnotatable

org.jboss.jdeparser.AbstractJGeneric

org.jboss.jdeparser.AbstractJClassDef

All Implemented Interfaces:

ClassContent, ClassFileContent, JAnnotatable, JClassDef, JClassDefSection, JCommentable, JDocCommentable, JGenericDef, Sectionable, Writable

Direct Known Subclasses:

AnnotationJClassDef, AnonymousJClassDef, EnumConstantJClassDef, EnumJClassDef, InterfaceJClassDef, PlainJClassDef

abstract class AbstractJClassDef
extends AbstractJGeneric
implements JClassDef, ClassFileContent, ClassContent, Sectionable

Field Summary

Fields

Modifier and Type	Field	Description
private JType	_extends
private ArrayList<JType>	_implements
private final ImplJSourceFile	classFile
private final ArrayList<ClassContent>	content
private final AbstractJClassDef	enclosingClass
private JType	erased
private JType	generic
private final int	mods
private final String	name

Constructor Summary

Constructors

Constructor	Description
AbstractJClassDef(int mods, String name)
AbstractJClassDef(int mods, AbstractJClassDef enclosingClass, String name)
AbstractJClassDef(int mods, ImplJSourceFile classFile, String name)

Method Summary

Modifier and Type	Method	Description
final JClassDef	_class(int mods, String name)	Add a nested class to this type.
JClassDef	_class(ArrayList<ClassContent> content, int mods, String name)
final JClassDef	_enum(int mods, String name)	Add a nested enum to this type.
JEnumConstant	_enum(String name)	Add an enum constant.
JClassDef	_enum(ArrayList<ClassContent> content, int mods, String name)
JClassDef	_extends(Class<?> clazz)	Add an extends type to this type.
JClassDef	_extends(String name)	Add an extends type to this type.
JClassDef	_extends(JType type)	Add an extends type to this type.
JClassDef	_implements(Class<?>... classes)	Add one or more implements type(s) to this type.
JClassDef	_implements(String... names)	Add one or more implements type(s) to this type.
JClassDef	_implements(JType... types)	Add one or more implements type(s) to this type.
final JClassDef	_interface(int mods, String name)	Add a nested interface to this type.
JClassDef	_interface(ArrayList<ClassContent> content, int mods, String name)
(package private) <C extends ClassContent> C	add(C item)
(package private) <C extends ClassContent> C	add(ArrayList<ClassContent> content, C item)
final JClassDef	annotationInterface(int mods, String name)	Add a nested annotation interface to this type.
JClassDef	annotationInterface(ArrayList<ClassContent> content, int mods, String name)
JClassDef	blankLine()	Add a blank line at this point of the type.
JComment	blockComment()	Add a block comment.
final JMethodDef	constructor(int mods)	Add a constructor to this type.
JMethodDef	constructor(ArrayList<ClassContent> content, int mods)
(package private) abstract Tokens.$KW	designation()
JType	erasedType()	Get the erased type corresponding to this type definition.
final JVarDeclaration	field(int mods, Class<?> type, String name)	Add a field to this type.
final JVarDeclaration	field(int mods, Class<?> type, String name, JExpr init)	Add a field to this type.
final JVarDeclaration	field(int mods, String type, String name)	Add a field to this type.
final JVarDeclaration	field(int mods, String type, String name, JExpr init)	Add a field to this type.
final JVarDeclaration	field(int mods, JType type, String name)	Add a field to this type.
final JVarDeclaration	field(int mods, JType type, String name, JExpr init)	Add a field to this type.
JVarDeclaration	field(ArrayList<ClassContent> content, int mods, JType type, String name, JExpr init)
JType	genericType()	Get a generic type for this type definition, where the type arguments are the same as the type parameters of this type (as defined at the time this method is called).
(package private) ImplJSourceFile	getClassFile()
(package private) Iterable<ClassContent>	getContent()
(package private) AbstractJClassDef	getEnclosingClass()
(package private) JType	getExtends()
(package private) Iterable<JType>	getImplements()
(package private) FormatPreferences.Indentation	getMemberIndentation()
int	getModifiers()
(package private) int	getMods()
(package private) String	getName()
boolean	hasAllModifiers(int mods)
boolean	hasAnyModifier(int mods)
(package private) boolean	hasInterfaceStyleExtends()
final JBlock	init()	Add a "raw" initialization block to this type definition.
JBlock	init(ArrayList<ClassContent> content)
JComment	lineComment()	Add a line comment.
final JMethodDef	method(int mods, Class<?> returnType, String name)	Add a method to this type.
final JMethodDef	method(int mods, String returnType, String name)	Add a method to this type.
final JMethodDef	method(int mods, JType returnType, String name)	Add a method to this type.
JMethodDef	method(ArrayList<ClassContent> content, int mods, JType returnType, String name)
(package private) boolean	methodCanHaveBody(int mods)
JClassDefSection	section()	Create a section at this point, into which additional items may be added.
final JBlock	staticInit()	Add a static initialization block to this type definition.
JBlock	staticInit(ArrayList<ClassContent> content)
(package private) boolean	supportsCompactInitOnly()
JTypeParamDef	typeParam(String name)	Define a type parameter.
void	write(SourceFileWriter writer)
(package private) void	writeClassHeader(SourceFileWriter sourceFileWriter)
(package private) void	writeContent(SourceFileWriter sourceFileWriter)
(package private) void	writeContentBlock(SourceFileWriter sourceFileWriter)

Methods inherited from class AbstractJGeneric

typeParams, typeParamsToArgs, writeTypeParams

Methods inherited from class BasicJAnnotatable

annotate, annotate, annotate, writeAnnotations

Methods inherited from class AbstractJDocCommentable

deprecated, docComment, writeDocComments

Methods inherited from class BasicJCommentable

writeComments

Methods inherited from class Object

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

Methods inherited from interface JAnnotatable

annotate, annotate, annotate

Methods inherited from interface JDocCommentable

deprecated, docComment

Methods inherited from interface JGenericDef

typeParams

Field Details

mods

private final int mods

name

private final String name

enclosingClass

private final AbstractJClassDef enclosingClass

classFile

private final ImplJSourceFile classFile

content

private final ArrayList<ClassContent> content

_extends

private JType _extends

_implements

private ArrayList<JType> _implements

erased

private JType erased

generic

private JType generic

Constructor Details

AbstractJClassDef

AbstractJClassDef(int mods,
 String name)

AbstractJClassDef

AbstractJClassDef(int mods,
 AbstractJClassDef enclosingClass,
 String name)

AbstractJClassDef

AbstractJClassDef(int mods,
 ImplJSourceFile classFile,
 String name)

Method Details

getEnclosingClass

AbstractJClassDef getEnclosingClass()

getClassFile

ImplJSourceFile getClassFile()

getMods

int getMods()

getName

String getName()

add

<C extends ClassContent> C add(C item)

add

<C extends ClassContent> C add(ArrayList<ClassContent> content,
 C item)

lineComment

public JComment lineComment()

Description copied from interface: JCommentable

Add a line comment.

Specified by:

lineComment in interface JCommentable

Overrides:

lineComment in class BasicJCommentable

Returns:

the line comment body

blockComment

public JComment blockComment()

Description copied from interface: JCommentable

Add a block comment.

Specified by:

blockComment in interface JCommentable

Overrides:

blockComment in class BasicJCommentable

Returns:

the block comment body

section

public JClassDefSection section()

Description copied from interface: JClassDefSection

Create a section at this point, into which additional items may be added.

Specified by:

section in interface JClassDefSection

Returns:

the new section to add

_extends

public JClassDef _extends(String name)

Description copied from interface: JClassDef

Add an extends type to this type.

Specified by:

_extends in interface JClassDef

Parameters:

name - the type name

Returns:

this type definition

_extends

public JClassDef _extends(JType type)

Description copied from interface: JClassDef

Add an extends type to this type.

Specified by:

_extends in interface JClassDef

Parameters:

type - the type

Returns:

this type definition

_extends

public JClassDef _extends(Class<?> clazz)

Description copied from interface: JClassDef

Add an extends type to this type.

Specified by:

_extends in interface JClassDef

Parameters:

clazz - the type

Returns:

this type definition

_implements

public JClassDef _implements(String... names)

Description copied from interface: JClassDef

Add one or more implements type(s) to this type.

Specified by:

_implements in interface JClassDef

Parameters:

names - the type name

Returns:

this type definition

_implements

public JClassDef _implements(JType... types)

Description copied from interface: JClassDef

Add one or more implements type(s) to this type.

Specified by:

_implements in interface JClassDef

Parameters:

types - the type

Returns:

this type definition

_implements

public JClassDef _implements(Class<?>... classes)

Description copied from interface: JClassDef

Add one or more implements type(s) to this type.

Specified by:

_implements in interface JClassDef

Parameters:

classes - the type

Returns:

this type definition

blankLine

public JClassDef blankLine()

Description copied from interface: JClassDef

Add a blank line at this point of the type.

Specified by:

blankLine in interface JClassDef

Specified by:

blankLine in interface JClassDefSection

Returns:

this type definition

erasedType

public JType erasedType()

Description copied from interface: JClassDef

Get the erased type corresponding to this type definition.

Specified by:

erasedType in interface JClassDef

Returns:

the erased type

genericType

public JType genericType()

Description copied from interface: JClassDef

Get a generic type for this type definition, where the type arguments are the same as the type parameters of this type (as defined at the time this method is called).

Specified by:

genericType in interface JClassDef

Returns:

the generic type

typeParam

public JTypeParamDef typeParam(String name)

Description copied from interface: JGenericDef

Define a type parameter.

Specified by:

typeParam in interface JGenericDef

Overrides:

typeParam in class AbstractJGeneric

Parameters:

name - the type parameter name

Returns:

the type parameter definition

init

public final JBlock init()

Description copied from interface: JClassDefSection

Add a "raw" initialization block to this type definition.

Specified by:

init in interface JClassDefSection

Returns:

the initialization block

init

public JBlock init(ArrayList<ClassContent> content)

Specified by:

init in interface Sectionable

staticInit

public final JBlock staticInit()

Description copied from interface: JClassDefSection

Add a static initialization block to this type definition.

Specified by:

staticInit in interface JClassDefSection

Returns:

the static initialization block

staticInit

public JBlock staticInit(ArrayList<ClassContent> content)

Specified by:

staticInit in interface Sectionable

_enum

public JEnumConstant _enum(String name)

Description copied from interface: JClassDef

Add an enum constant. If the class being defined is not an enum, an exception is thrown.

Specified by:

_enum in interface JClassDef

Parameters:

name - the constant name

Returns:

the call for enum construction

field

public JVarDeclaration field(ArrayList<ClassContent> content,
 int mods,
 JType type,
 String name,
 JExpr init)

Specified by:

field in interface Sectionable

field

public final JVarDeclaration field(int mods,
 JType type,
 String name)

Description copied from interface: JClassDefSection

Add a field to this type.

Specified by:

field in interface JClassDefSection

Parameters:

mods - the modifiers

type - the field type

name - the field name

Returns:

the field declaration

field

public final JVarDeclaration field(int mods,
 JType type,
 String name,
 JExpr init)

Description copied from interface: JClassDefSection

Add a field to this type.

Specified by:

field in interface JClassDefSection

Parameters:

mods - the modifiers

type - the field type

name - the field name

init - the field assigned value

Returns:

the field declaration

field

public final JVarDeclaration field(int mods,
 Class<?> type,
 String name)

Description copied from interface: JClassDefSection

Add a field to this type.

Specified by:

field in interface JClassDefSection

Parameters:

mods - the modifiers

type - the field type

name - the field name

Returns:

the field declaration

field

public final JVarDeclaration field(int mods,
 Class<?> type,
 String name,
 JExpr init)

Description copied from interface: JClassDefSection

Add a field to this type.

Specified by:

field in interface JClassDefSection

Parameters:

mods - the modifiers

type - the field type

name - the field name

init - the field assigned value

Returns:

the field declaration

field

public final JVarDeclaration field(int mods,
 String type,
 String name)

Description copied from interface: JClassDefSection

Add a field to this type.

Specified by:

field in interface JClassDefSection

Parameters:

mods - the modifiers

type - the field type

name - the field name

Returns:

the field declaration

field

public final JVarDeclaration field(int mods,
 String type,
 String name,
 JExpr init)

Description copied from interface: JClassDefSection

Add a field to this type.

Specified by:

field in interface JClassDefSection

Parameters:

mods - the modifiers

type - the field type

name - the field name

init - the field assigned value

Returns:

the field declaration

method

public JMethodDef method(ArrayList<ClassContent> content,
 int mods,
 JType returnType,
 String name)

Specified by:

method in interface Sectionable

method

public final JMethodDef method(int mods,
 JType returnType,
 String name)

Description copied from interface: JClassDefSection

Add a method to this type.

Specified by:

method in interface JClassDefSection

Parameters:

mods - the modifiers

returnType - the method return type

name - the method name

Returns:

the method definition

method

public final JMethodDef method(int mods,
 Class<?> returnType,
 String name)

Description copied from interface: JClassDefSection

Add a method to this type.

Specified by:

method in interface JClassDefSection

Parameters:

mods - the modifiers

returnType - the method return type

name - the method name

Returns:

the method definition

method

public final JMethodDef method(int mods,
 String returnType,
 String name)

Description copied from interface: JClassDefSection

Add a method to this type.

Specified by:

method in interface JClassDefSection

Parameters:

mods - the modifiers

returnType - the method return type

name - the method name

Returns:

the method definition

methodCanHaveBody

boolean methodCanHaveBody(int mods)

hasInterfaceStyleExtends

boolean hasInterfaceStyleExtends()

supportsCompactInitOnly

boolean supportsCompactInitOnly()

constructor

public JMethodDef constructor(ArrayList<ClassContent> content,
 int mods)

Specified by:

constructor in interface Sectionable

constructor

public final JMethodDef constructor(int mods)

Description copied from interface: JClassDefSection

Add a constructor to this type.

Specified by:

constructor in interface JClassDefSection

Parameters:

mods - the modifiers

Returns:

the constructor definition

_class

public JClassDef _class(ArrayList<ClassContent> content,
 int mods,
 String name)

Specified by:

_class in interface Sectionable

_enum

public JClassDef _enum(ArrayList<ClassContent> content,
 int mods,
 String name)

Specified by:

_enum in interface Sectionable

_interface

public JClassDef _interface(ArrayList<ClassContent> content,
 int mods,
 String name)

Specified by:

_interface in interface Sectionable

annotationInterface

public JClassDef annotationInterface(ArrayList<ClassContent> content,
 int mods,
 String name)

Specified by:

annotationInterface in interface Sectionable

_class

public final JClassDef _class(int mods,
 String name)

Description copied from interface: JClassDefSection

Add a nested class to this type.

Specified by:

_class in interface JClassDefSection

Parameters:

mods - the class modifiers

name - the class name

Returns:

the nested class

_enum

public final JClassDef _enum(int mods,
 String name)

Description copied from interface: JClassDefSection

Add a nested enum to this type.

Specified by:

_enum in interface JClassDefSection

Parameters:

mods - the enum modifiers

name - the enum name

Returns:

the nested enum

_interface

public final JClassDef _interface(int mods,
 String name)

Description copied from interface: JClassDefSection

Add a nested interface to this type.

Specified by:

_interface in interface JClassDefSection

Parameters:

mods - the interface modifiers

name - the interface name

Returns:

the nested interface

annotationInterface

public final JClassDef annotationInterface(int mods,
 String name)

Description copied from interface: JClassDefSection

Add a nested annotation interface to this type.

Specified by:

annotationInterface in interface JClassDefSection

Parameters:

mods - the annotation interface modifiers

name - the annotation interface name

Returns:

the nested annotation interface

getContent

Iterable<ClassContent> getContent()

getExtends

JType getExtends()

getImplements

Iterable<JType> getImplements()

designation

abstract Tokens.$KW designation()

getMemberIndentation

FormatPreferences.Indentation getMemberIndentation()

write

public void write(SourceFileWriter writer)
           throws IOException

Specified by:

write in interface Writable

Throws:

IOException

writeContentBlock

void writeContentBlock(SourceFileWriter sourceFileWriter)
                throws IOException

Throws:

IOException

writeClassHeader

void writeClassHeader(SourceFileWriter sourceFileWriter)
               throws IOException

Throws:

IOException

writeContent

void writeContent(SourceFileWriter sourceFileWriter)
           throws IOException

Throws:

IOException

getModifiers

public int getModifiers()

hasAllModifiers

public boolean hasAllModifiers(int mods)

hasAnyModifier

public boolean hasAnyModifier(int mods)