Package io.sundr.model

Class Method

java.lang.Object

io.sundr.model.AttributeSupport

io.sundr.model.ModifierSupport

io.sundr.model.Method

All Implemented Interfaces:

Annotatable, Attributeable, Commentable, Node, Renderable

public class Method
extends ModifierSupport
implements Renderable, Commentable, Annotatable

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT

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
Method(List<String> comments, List<AnnotationRef> annotations, List<TypeParamDef> parameters, String name, TypeRef returnType, List<Property> arguments, boolean varArgPreferred, List<ClassRef> exceptions, boolean defaultMethod, Block block, Modifiers modifiers, Map<AttributeKey,Object> attributes)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
List<AnnotationRef>	getAnnotations()
List<Property>	getArguments()
Block	getBlock()
List<String>	getComments()	Get the list of comments.
List<ClassRef>	getExceptions()
String	getName()
List<TypeParamDef>	getParameters()
Set<ClassRef>	getReferences()
TypeRef	getReturnType()
String	getSignature()
int	hashCode()
boolean	isDefaultMethod()
boolean	isVarArgPreferred()
static Method	newMethod(String name, TypeRef returnType, boolean varArgPrefered, Property... arguments)
static Method	newMethod(String name, TypeRef returnType, Property... arguments)
String	render()	Render the type into a String for the purpose of code generation.
String	render(TypeDef enclosingType)
String	renderDefinition(TypeDef enclosingType)
void	renderDefinition(StringBuilder sb, TypeDef enclosingType)
String	toString()
Method	withErasure()

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

Field Detail

DEFAULT

public static final String DEFAULT

See Also:

Constant Field Values

Constructor Detail

Method

public Method(List<String> comments,
              List<AnnotationRef> annotations,
              List<TypeParamDef> parameters,
              String name,
              TypeRef returnType,
              List<Property> arguments,
              boolean varArgPreferred,
              List<ClassRef> exceptions,
              boolean defaultMethod,
              Block block,
              Modifiers modifiers,
              Map<AttributeKey,Object> attributes)

Method Detail

newMethod

public static Method newMethod(String name,
                               TypeRef returnType,
                               boolean varArgPrefered,
                               Property... arguments)

newMethod

public static Method newMethod(String name,
                               TypeRef returnType,
                               Property... arguments)

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.

getAnnotations

public List<AnnotationRef> getAnnotations()

Specified by:

getAnnotations in interface Annotatable

isVarArgPreferred

public boolean isVarArgPreferred()

getParameters

public List<TypeParamDef> getParameters()

getName

public String getName()

getReturnType

public TypeRef getReturnType()

getArguments

public List<Property> getArguments()

getExceptions

public List<ClassRef> getExceptions()

isDefaultMethod

public boolean isDefaultMethod()

getBlock

public Block getBlock()

withErasure

public Method withErasure()

getReferences

public Set<ClassRef> getReferences()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getSignature

public String getSignature()

renderDefinition

public String renderDefinition(TypeDef enclosingType)

renderDefinition

public void renderDefinition(StringBuilder sb,
                             TypeDef enclosingType)

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.

render

public String render(TypeDef enclosingType)

toString

public String toString()

Overrides:

toString in class Object