Class ClassModel

java.lang.Object

io.helidon.codegen.classmodel.ClassBase

io.helidon.codegen.classmodel.ClassModel

public final class ClassModel
extends ClassBase

Entry point to create class model. This model contain all needed information for each generated type and handles resulting generation.

The following types are supported (through ClassBase.Builder.classType(io.helidon.common.types.ElementKind)):

• ElementKind.CLASS: class
• ElementKind.INTERFACE: interface, all fields are constants, cannot have constructor
• ElementKind.ENUM: enum, use ClassBase.Builder.addEnumConstant(java.util.function.Consumer) to add enum constants
• ElementKind.RECORD: record, use ClassBase.Builder.addField(Field) to add record components, as non-static fields are not supported in records

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ClassModel.Builder	Fluent API builder for ClassModel.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_PADDING	Default padding used in the generated type.
static final String	PADDING_TOKEN	Padding token used for identifying extra padding requirement for content formatting.
static final String	TYPE_TOKEN	Type token is used to prepend and append to the fully qualified type names to support import handling.
static final String	TYPE_TOKEN_PATTERN	Pattern in which are type names saved in the content templates.

Method Summary

Modifier and Type	Method	Description
AccessModifier	accessModifier()	Access modifier of this component.
List<Annotation>	annotations()	List of annotations on this component.
static ClassModel.Builder	builder()	Create new ClassModel.Builder instance.
List<String>	description()	Description (javadoc) of this component.
String	name()	Name of this component.
String	toString()
TypeName	typeName()	Type name of this class.
void	write(Writer writer)	Write created type model.
void	write(Writer writer, String padding)	Write created type model.

Methods inherited from class ClassBase

constructors, fields, genericArguments, innerClasses, interfaceTypeNames, isAbstract, isFinal, isStatic, kind, methods, permittedSubclassTypeNames, sealed, superTypeName

Modifier and Type	Method	Description
List<Constructor>	constructors()	All declared constructors.
List<Field>	fields()	All declared fields.
List<TypeArgument>	genericArguments()	Generic type parameters declared by this type, including their bounds.
List<ClassBase>	innerClasses()	All declared inner classes.
List<TypeName>	interfaceTypeNames()	Implemented interfaces.
boolean	isAbstract()	Is this an abstract class.
boolean	isFinal()	Is this a final class.
boolean	isStatic()	Is this a static class.
ElementKind	kind()	Kind of this type.
List<Method>	methods()	All declared methods.
List<TypeName>	permittedSubclassTypeNames()	Permitted direct subclasses of this sealed class or interface.
boolean	sealed()	Is this a sealed class or interface.
Optional<TypeName>	superTypeName()	Type name of the super class (if this is a class and it extends another class).

Methods inherited from class Object

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

Field Details

PADDING_TOKEN

public static final String PADDING_TOKEN

Padding token used for identifying extra padding requirement for content formatting.

See Also:

• Constant Field Values

TYPE_TOKEN

public static final String TYPE_TOKEN

Type token is used to prepend and append to the fully qualified type names to support import handling.

See Also:

• Constant Field Values

TYPE_TOKEN_PATTERN

public static final String TYPE_TOKEN_PATTERN

Pattern in which are type names saved in the content templates.

See Also:

• Constant Field Values

DEFAULT_PADDING

public static final String DEFAULT_PADDING

Default padding used in the generated type.

See Also:

• Constant Field Values

Method Details

builder

public static ClassModel.Builder builder()

Create new ClassModel.Builder instance.

Returns:

new builder instance

write

public void write(Writer writer)
           throws IOException

Write created type model. Default padding DEFAULT_PADDING is used.

Parameters:

writer - writer to be used

Throws:

IOException - write operation failure

write

public void write(Writer writer,
 String padding)
           throws IOException

Write created type model.

Parameters:

writer - writer to be used

padding - padding to be used

Throws:

IOException - write operation failure

typeName

public TypeName typeName()

Type name of this class.

Returns:

type name

toString

public String toString()

Overrides:

toString in class Object

annotations

public List<Annotation> annotations()

List of annotations on this component.

Returns:

annotations

name

public String name()

Name of this component.

Returns:

component name

accessModifier

public AccessModifier accessModifier()

Access modifier of this component.

Returns:

access modifier

description

public List<String> description()

Description (javadoc) of this component.

Returns:

description lines