io.sundr.model

Interface Renderable

All Known Implementing Classes:

AnnotationRef, ClassRef, Method, PrimitiveRef, Property, TypeDef, TypeParamDef, TypeParamRef, TypeRef, VoidRef, WildcardRef

public interface Renderable

Method Summary

Modifier and Type	Method and Description
default String	render() Render the type into a String for the purpose of code generation.
default String	render(TypeDef enclosingType) Render the type into a String for the purpose of code generation.

Method Detail

render

default String render()

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.

Returns:

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

render

default String render(TypeDef enclosingType)

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. In contrast with its no-arg equivallent this method is idempotent.

Parameters:

enclosingType - The type that encoses the current Renderable.

Returns:

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