Class ClassModel.Builder

java.lang.Object

io.helidon.codegen.classmodel.ClassBase.Builder<ClassModel.Builder, ClassModel>

io.helidon.codegen.classmodel.ClassModel.Builder

All Implemented Interfaces:

Builder<ClassModel.Builder, ClassModel>, Supplier<ClassModel>

Enclosing class:

ClassModel

public static final class ClassModel.Builder
extends ClassBase.Builder<ClassModel.Builder, ClassModel>

Fluent API builder for ClassModel.

Method Summary

Modifier and Type	Method	Description
ClassModel.Builder	accessModifier(AccessModifier accessModifier)
ClassModel.Builder	addAnnotation(Annotation annotation)	Add new annotation to the component.
ClassModel.Builder	addAnnotation(Annotation.Builder builder)	Add new annotation to the component.
ClassModel.Builder	addAnnotation(Annotation annotation)	Add new annotation to the component.
ClassModel.Builder	addAnnotation(Consumer<Annotation.Builder> consumer)	Add new annotation to the component.
ClassModel.Builder	addDescriptionLine(String line)
ClassModel	build()	Build the instance from this builder.
ClassModel.Builder	copyright(String copyright)	Copyright header to be used.
ClassModel.Builder	description(String description)
ClassModel.Builder	description(List<String> description)
Optional<ClassBase>	find(TypeName typeName)	Find if the provided type name is handled as part of this generated class.
ClassModel.Builder	includeImport(boolean includeImport)	Whether to include import type information among the imports.
ClassModel.Builder	name(String name)
ClassModel.Builder	packageName(String packageName)	Package name of this type.
ClassModel.Builder	staticInitializer(Consumer<ContentBuilder<?>> contentBuilder)	Update the static initializer of this class.
ClassModel.Builder	type(TypeName type)

Methods inherited from class ClassBase.Builder

addConstructor, addConstructor, addEnumConstant, addField, addField, addField, addGenericArgument, addGenericArgument, addImport, addImport, addImport, addInnerClass, addInnerClass, addInnerClass, addInterface, addInterface, addInterface, addJavadocTag, addMethod, addMethod, addMethod, addPermittedSubclass, addPermittedSubclass, addPermittedSubclass, addStaticImport, classType, isAbstract, isFinal, javadoc, sealed, sortFields, sortStaticFields, superType, superType, superType

Modifier and Type	Method	Description
ClassModel.Builder	addConstructor(Constructor.Builder constructor)	Add new constructor to this class.
ClassModel.Builder	addConstructor(Consumer<Constructor.Builder> consumer)	Add new constructor to this class.
ClassModel.Builder	addEnumConstant(Consumer<EnumConstant.Builder> builderConsumer)	Add an enum constant (only valid if the class type is set to ENUM.
ClassModel.Builder	addField(Field field)	Add new field to the type.
ClassModel.Builder	addField(Field.Builder builder)	Add new field to the type.
ClassModel.Builder	addField(Consumer<Field.Builder> consumer)	Add new field to the type.
ClassModel.Builder	addGenericArgument(TypeArgument typeArgument)	Add generic argument type.
ClassModel.Builder	addGenericArgument(Consumer<TypeArgument.Builder> consumer)	Add generic argument type.
ClassModel.Builder	addImport(TypeName typeName)	Add specific fully qualified type name to be imported.
ClassModel.Builder	addImport(Class<?> typeImport)	Add specific class to be imported.
ClassModel.Builder	addImport(String importName)	Add specific fully qualified type name to be imported.
ClassModel.Builder	addInnerClass(InnerClass innerClass)	Add new inner type to this type.
ClassModel.Builder	addInnerClass(Consumer<InnerClass.Builder> consumer)	Add new inner type to this type.
ClassModel.Builder	addInnerClass(Supplier<InnerClass> supplier)	Add new inner type to this type.
ClassModel.Builder	addInterface(TypeName interfaceType)	Add interface this type should implement.
ClassModel.Builder	addInterface(Class<?> interfaceType)	Add interface this type should implement.
ClassModel.Builder	addInterface(String interfaceName)	Add interface this type should implement.
ClassModel.Builder	addJavadocTag(String tag, String description)
ClassModel.Builder	addMethod(Method method)	Add new method to the type.
ClassModel.Builder	addMethod(Method.Builder builder)	Add new method to the type.
ClassModel.Builder	addMethod(Consumer<Method.Builder> consumer)	Add new method to the type.
ClassModel.Builder	addPermittedSubclass(TypeName permittedSubclass)	Add a permitted direct subclass of this sealed type.
ClassModel.Builder	addPermittedSubclass(Class<?> permittedSubclass)	Add a permitted direct subclass of this sealed type.
ClassModel.Builder	addPermittedSubclass(String permittedSubclass)	Add a permitted direct subclass of this sealed type.
ClassModel.Builder	addStaticImport(String staticImport)	Add specific static import.
ClassModel.Builder	classType(ElementKind kind)	Type of the Java type we are creating.
ClassModel.Builder	isAbstract(boolean isAbstract)	Whether this type is abstract.
ClassModel.Builder	isFinal(boolean isFinal)	Whether this type is final.
ClassModel.Builder	javadoc(Javadoc javadoc)
ClassModel.Builder	sealed(boolean sealed)	Whether this type is sealed.
ClassModel.Builder	sortFields(boolean sort)	Whether to sort non-static fields by type and name (defaults to true).
ClassModel.Builder	sortStaticFields(boolean sort)	Whether to sort static fields by type and name (defaults to true).
ClassModel.Builder	superType(TypeName superType)	Set new super type of this type.
ClassModel.Builder	superType(Class<?> superType)	Set new super type of this type.
ClassModel.Builder	superType(String superType)	Set new fully qualified super type name of this type.

Methods inherited from class Object

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

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default ClassModel	get()
default ClassModel.Builder	identity()	Instance of this builder as the correct type.
default ClassModel.Builder	update(Consumer<ClassModel.Builder> consumer)	Update the builder in a fluent API way.

Method Details

build

public ClassModel build()

Description copied from interface: Builder

Build the instance from this builder.

Returns:

instance of the built type

accessModifier

public ClassModel.Builder accessModifier(AccessModifier accessModifier)

Overrides:

accessModifier in class ClassBase.Builder<ClassModel.Builder, ClassModel>

packageName

public ClassModel.Builder packageName(String packageName)

Package name of this type.

Parameters:

packageName - type package name

Returns:

updated builder instance

copyright

public ClassModel.Builder copyright(String copyright)

Copyright header to be used.

Parameters:

copyright - copyright header

Returns:

updated builder instance

name

public ClassModel.Builder name(String name)

type

public ClassModel.Builder type(TypeName type)

staticInitializer

public ClassModel.Builder staticInitializer(Consumer<ContentBuilder<?>> contentBuilder)

Update the static initializer of this class.

Parameters:

contentBuilder - content builder consumer to update the static initializer

Returns:

updated builder instance

find

public Optional<ClassBase> find(TypeName typeName)

Find if the provided type name is handled as part of this generated class.

Parameters:

typeName - type name to look for

Returns:

class base that matches the provided type name

description

public ClassModel.Builder description(String description)

description

public ClassModel.Builder description(List<String> description)

addDescriptionLine

public ClassModel.Builder addDescriptionLine(String line)

addAnnotation

public ClassModel.Builder addAnnotation(Annotation annotation)

Add new annotation to the component.

Parameters:

annotation - annotation instance

Returns:

updated builder instance

addAnnotation

public ClassModel.Builder addAnnotation(Consumer<Annotation.Builder> consumer)

Add new annotation to the component.

Parameters:

consumer - annotation builder consumer

Returns:

updated builder instance

addAnnotation

public ClassModel.Builder addAnnotation(Annotation.Builder builder)

Add new annotation to the component.

Parameters:

builder - annotation builder

Returns:

updated builder instance

addAnnotation

public ClassModel.Builder addAnnotation(Annotation annotation)

Add new annotation to the component.

Parameters:

annotation - annotation instance

Returns:

updated builder instance

includeImport

public ClassModel.Builder includeImport(boolean includeImport)

Whether to include import type information among the imports.

Parameters:

includeImport - whether imports should be included

Returns:

updated builder instance