Package io.sundr.model

Class ClassRef

java.lang.Object

io.sundr.model.AttributeSupport

io.sundr.model.TypeRef

io.sundr.model.ClassRef

All Implemented Interfaces:

Attributeable, Mappable<ClassRef>, Nameable, Node, Renderable

public class ClassRef
extends TypeRef
implements Nameable, Mappable<ClassRef>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BRACKETS
static final ClassRef	OBJECT
static final String	UNKNOWN

Fields inherited from interface io.sundr.model.Attributeable

ALSO_IMPORT, DEFAULT_VALUE, INIT, INIT_FUNCTION, LAZY_INIT

Fields inherited from interface io.sundr.model.Nameable

IN_PACKAGE, IS_UPPER_CASE, OUT_OF_PACKAGE, PACKAGE_SEPARATOR_REGEX

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
ClassRef(String fullyQualifiedName, int dimensions, List<TypeRef> arguments, Map<AttributeKey,Object> attributes)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static ClassRef	forClass(Class c)
static ClassRef	forName(String fullyQualifiedName)
List<TypeRef>	getArguments()
int	getDimensions()
String	getFullyQualifiedName()	Get the fully qualified name of the type.
String	getName()	Get the name.
Set<ClassRef>	getReferences()
int	hashCode()
String	render()	Render the type into a String for the purpose of code generation.
String	toString()
ClassRef	withDimensions(int dimensions)

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

map

Methods inherited from interface io.sundr.model.Nameable

getPackageName

Methods inherited from interface io.sundr.model.Node

indent

Methods inherited from interface io.sundr.model.Renderable

tab

Field Details

UNKNOWN

public static final String UNKNOWN

See Also:

• Constant Field Values

BRACKETS

public static final String BRACKETS

See Also:

• Constant Field Values

OBJECT

public static final ClassRef OBJECT

Constructor Details

ClassRef

public ClassRef(String fullyQualifiedName,
 int dimensions,
 List<TypeRef> arguments,
 Map<AttributeKey,Object> attributes)

Method Details

forName

public static ClassRef forName(String fullyQualifiedName)

forClass

public static ClassRef forClass(Class c)

getFullyQualifiedName

public String getFullyQualifiedName()

Description copied from interface: Nameable

Get the fully qualified name of the type. The expected format is package.outerClass.inerClass

Specified by:

getFullyQualifiedName in interface Nameable

Returns:

the fully qualified name

getDimensions

public int getDimensions()

Specified by:

getDimensions in class TypeRef

getArguments

public List<TypeRef> getArguments()

withDimensions

public ClassRef withDimensions(int dimensions)

Specified by:

withDimensions in class TypeRef

getReferences

public Set<ClassRef> getReferences()

getName

public String getName()

Description copied from interface: Nameable

Get the name.

Specified by:

getName in interface Nameable

Specified by:

getName in class TypeRef

Returns:

the name

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

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