Package io.sundr.model

Class Property

java.lang.Object

io.sundr.model.AttributeSupport

io.sundr.model.ModifierSupport

io.sundr.model.Property

All Implemented Interfaces:

Annotatable, Attributeable, Commentable, Node, Renderable

public class Property
extends ModifierSupport
implements Renderable, Commentable, Annotatable

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.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
Property(Modifiers modifiers, Map<AttributeKey,Object> attributes, List<String> comments, List<AnnotationRef> annotations, TypeRef typeRef, String name, Optional<Expression> initialValue, boolean enumConstant, boolean synthetic)
Property(List<AnnotationRef> annotations, TypeRef typeRef, String name, List<String> comments, boolean enumConstant, boolean synthetic, Modifiers modifiers, Map<AttributeKey,Object> attributes)	Deprecated.
Property(List<AnnotationRef> annotations, TypeRef typeRef, String name, List<String> comments, Modifiers modifiers, Map<AttributeKey,Object> attributes)	Deprecated.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
List<AnnotationRef>	getAnnotations()
List<String>	getComments()	Get the list of comments.
protected String	getDefaultValue()	Deprecated.
Optional<Expression>	getInitialValue()
String	getName()
String	getNameCapitalized()
Set<ClassRef>	getReferences()
TypeRef	getTypeRef()
int	hashCode()
boolean	isEnumConstant()
boolean	isSynthetic()
static Property	newProperty(TypeRef typeRef, String name)
static Property	newProperty(Class type, String name)
static Property	newProperty(String name)
String	render()	Render the type into a String for the purpose of code generation.
PropertyRef	toReference()
String	toString()
Property	withErasure()	Get the property after the type erasure is applied.
Property	withInitialValue(Expression initialValue)	Get the property with the specified object as iniital value.
Property	withInitialValue(Object initialValue)	Get the property with the specified object as iniital value.
Property	withInitialValue(Optional<Expression> initialValue)	Get the property with the specified initial value
Property	withoutInitialValue()	Get the property without its initial value.
protected Property	withoutModiers()	This is only used for rendering method arguments, where we usually string modifiers.

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.Node

indent

Methods inherited from interface io.sundr.model.Renderable

tab

Constructor Detail

Property

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

Property

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

Deprecated.

Property

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

Deprecated.

Method Detail

newProperty

public static Property newProperty(String name)

newProperty

public static Property newProperty(Class type,
                                   String name)

newProperty

public static Property newProperty(TypeRef typeRef,
                                   String name)

getAnnotations

public List<AnnotationRef> getAnnotations()

Specified by:

getAnnotations in interface Annotatable

getTypeRef

public TypeRef getTypeRef()

getName

public String getName()

getComments

public List<String> getComments()

Description copied from interface: Commentable

Get the list of comments.

Specified by:

getComments in interface Commentable

Returns:

a List of comments.

isEnumConstant

public boolean isEnumConstant()

isSynthetic

public boolean isSynthetic()

getInitialValue

public Optional<Expression> getInitialValue()

getNameCapitalized

public String getNameCapitalized()

getReferences

public Set<ClassRef> getReferences()

withoutModiers

protected Property withoutModiers()

This is only used for rendering method arguments, where we usually string modifiers.

Returns:

the property without any modifiers

withErasure

public Property withErasure()

Get the property after the type erasure is applied. This in essense means that the type parameters are replaced by Object.

Returns:

the 'erased` property.

withoutInitialValue

public Property withoutInitialValue()

Get the property without its initial value.

Returns:

the property.

withInitialValue

public Property withInitialValue(Object initialValue)

Get the property with the specified object as iniital value.

Parameters:

initialValue - an Object

Returns:

the property.

withInitialValue

public Property withInitialValue(Expression initialValue)

Get the property with the specified object as iniital value.

Parameters:

initialValue - an Expression

Returns:

the property.

withInitialValue

public Property withInitialValue(Optional<Expression> initialValue)

Get the property with the specified initial value

Parameters:

initialValue - an Optional Expression

Returns:

the property.

getDefaultValue

@Deprecated
protected String getDefaultValue()

Deprecated.

Get the default value of the property The mehotd is deprecated, use getInitialValue() instead.

Returns:

String the default value of the Property

toReference

public PropertyRef toReference()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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.

toString

public String toString()

Overrides:

toString in class Object