Package io.sundr.model

Class Field

java.lang.Object

io.sundr.model.AttributeSupport

io.sundr.model.ModifierSupport

io.sundr.model.Variable<TypeRef>

io.sundr.model.Field

All Implemented Interfaces:

Annotatable, Attributeable, Commentable, Erasable<Field>, Expression, Node, Renderable, WithName, WithReferences

public class Field
extends Variable<TypeRef>
implements Erasable<Field>

Field Summary

Fields inherited from class io.sundr.model.ModifierSupport

ABSTRACT, FINAL, modifiers, PRIVATE, PROTECTED, PUBLIC, STATIC, SYNCHRONIZED

Fields inherited from interface io.sundr.model.Attributeable

ALSO_IMPORT, DEFAULT_VALUE, INIT, INIT_FUNCTION, LAZY_INIT

Fields inherited from interface io.sundr.model.Expression

NULL

Fields inherited from interface io.sundr.model.Node

AT, CB, CC, CLP, COLN, COMA, CP, DOT, DQ, EMPTY, EQ, EXTENDS, GT, IMPLEMENTS, INDENT, JAVA_LANG, JAVA_LANG_ENUM, JAVA_LANG_OBJECT, JAVA_LANG_STRING, LT, NEWLINE, NEWLINE_PATTERN, OB, OC, OP, Q, SEMICOLN, SEMICOLN_SUFFIX_PATTERN, SPACE, STAR, THROWS, VARARG

Constructor Summary

Constructors

Constructor	Description
Field(Modifiers modifiers, Map<AttributeKey,Object> attributes, List<String> comments, List<AnnotationRef> annotations, TypeRef typeRef, String name, Optional<Expression> initialValue, boolean enumConstant, boolean synthetic)
Field(List<AnnotationRef> annotations, TypeRef typeRef, String name, List<String> comments, boolean enumConstant, boolean synthetic, Modifiers modifiers, Map<AttributeKey,Object> attributes)
Field(List<AnnotationRef> annotations, TypeRef typeRef, String name, List<String> comments, Modifiers modifiers, Map<AttributeKey,Object> attributes)

Method Summary

Modifier and Type	Method	Description
String	getErasure()	Returns the erasure of this type as a canonical string representation.
static Field	newField(TypeRef typeRef, String name)
static Field	newField(Class<?> type, String name)
static Field	newField(String name)
String	render()	Render the type into a String for the purpose of code generation.
Field	withErasure()	Returns an erased version of this object with generic type information removed.
Field	withInitialValue(Expression initialValue)
Field	withInitialValue(Object initialValue)
Field	withInitialValue(Optional<Expression> initialValue)
Field	withoutInitialValue()
protected Field	withoutModifiers()

Methods inherited from class io.sundr.model.Variable

asArgument, asField, asLocalVariable, equals, getAnnotations, getComments, getInitialValue, getName, getNameCapitalized, getReferences, getTypeRef, hashCode, isEnumConstant, isSynthetic, renderExpression, toString

Methods inherited from class io.sundr.model.ModifierSupport

getModifiers, isAbstract, isFinal, isNative, isPrivate, isProtected, isPublic, isStatic, isSynchronized, isTransient, renderModifiers, renderModifiers

Methods inherited from class io.sundr.model.AttributeSupport

getAttribute, getAttributes, hasAttribute

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.sundr.model.Annotatable

renderAnnotations

Methods inherited from interface io.sundr.model.Commentable

renderComments

Methods inherited from interface io.sundr.model.Expression

and, and, assign, assign, assignNew, assignNew, assignNull, call, call, cast, cast, divide, enclosed, eq, index, index, instanceOf, instanceOf, isNull, minus, minus, modulo, multiply, ne, negative, not, notNull, or, or, plus, plus, positive, postDecrement, postIncrement, preIncrement, pretDecrement, property, property, property, ret

Methods inherited from interface io.sundr.model.Node

indent

Methods inherited from interface io.sundr.model.Renderable

tab

Constructor Details

Field

public Field(Modifiers modifiers,
 Map<AttributeKey,Object> attributes,
 List<String> comments,
 List<AnnotationRef> annotations,
 TypeRef typeRef,
 String name,
 Optional<Expression> initialValue,
 boolean enumConstant,
 boolean synthetic)

Field

public Field(List<AnnotationRef> annotations,
 TypeRef typeRef,
 String name,
 List<String> comments,
 boolean enumConstant,
 boolean synthetic,
 Modifiers modifiers,
 Map<AttributeKey,Object> attributes)

Field

public Field(List<AnnotationRef> annotations,
 TypeRef typeRef,
 String name,
 List<String> comments,
 Modifiers modifiers,
 Map<AttributeKey,Object> attributes)

Method Details

newField

public static Field newField(String name)

newField

public static Field newField(Class<?> type,
 String name)

newField

public static Field newField(TypeRef typeRef,
 String name)

withoutModifiers

protected Field withoutModifiers()

withErasure

public Field withErasure()

Description copied from interface: Erasable

Returns an erased version of this object with generic type information removed. This creates a canonical instance that can be used for comparison and resolution.

Specified by:

withErasure in interface Erasable<Field>

Returns:

the erased version of this object

getErasure

public String getErasure()

Description copied from interface: Erasable

Returns the erasure of this type as a canonical string representation. The erasure removes generic type parameters and provides a stable way to compare types regardless of generic instantiation.

Specified by:

getErasure in interface Erasable<Field>

Returns:

the type erasure string

withoutInitialValue

public Field withoutInitialValue()

withInitialValue

public Field withInitialValue(Object initialValue)

withInitialValue

public Field withInitialValue(Expression initialValue)

withInitialValue

public Field withInitialValue(Optional<Expression> initialValue)

render

public String render()

Description copied from interface: Renderable

Render the type into a String for the purpose of code generation. This is slightly different from the `toString()` method as `toString()` is mostly needed for logging / debugging and should be idempotent. Regarding idempotency this method may yield different result based on the context it is used even if the internal state of the object does not change. An example of such case, is a reference to class that may change based on the package from which it's refenced.

Specified by:

render in interface Renderable

Returns:

the String representation of the object as it's meant to appear in the generated code.