io.sphere.sdk.annotations.processors.models

Class PropertyGenModel

java.lang.Object

io.sphere.sdk.annotations.processors.models.PropertyGenModel

public class PropertyGenModel
extends Object

This class provides a model for properties of a TypeElement.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getCapitalizedName()
String	getJavadocLinkTag() Returns the javadoc link tag that links back this properties getter method.
String	getJavaIdentifier()
String	getJsonName() Returns the name of this poroperty as specified with JsonProperty
String	getMethodName() Returns the getter method name for this property.
String	getName()
static String	getPropertyName(ExecutableElement propertyMethod) Returns the property name of the given property method.
com.squareup.javapoet.TypeName	getType()
com.squareup.javapoet.TypeName	getTypeArgument(int index)
int	hashCode()
boolean	hasSameType(Class<?> clazz) Returns true if the qualified name of this type is equal to the canonical name of the given class.
boolean	isDeprecated()
boolean	isOptional()
static PropertyGenModel	of(ExecutableElement getterMethod) Creates an instance from the given getter method.
static PropertyGenModel	of(String name, String jsonName, TypeMirror type, String javaDocLinkTag, boolean optional, boolean useReference)
com.squareup.javapoet.TypeName	replaceParameterizedType(Class<?> replacementType) Replaces the parameterized type of this type with the given replacement type.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

getCapitalizedName

public String getCapitalizedName()

getJsonName

public String getJsonName()

Returns the name of this poroperty as specified with JsonProperty

Returns:

the json name or null if the JsonProperty isn't present

getJavaIdentifier

public String getJavaIdentifier()

getType

public com.squareup.javapoet.TypeName getType()

getMethodName

public String getMethodName()

Returns the getter method name for this property.

Returns:

the getter method name

getJavadocLinkTag

public String getJavadocLinkTag()

Returns the javadoc link tag that links back this properties getter method.

Returns:

the javadoc link tag pointing to this property

isOptional

public boolean isOptional()

isDeprecated

public boolean isDeprecated()

hasSameType

public boolean hasSameType(Class<?> clazz)

Returns true if the qualified name of this type is equal to the canonical name of the given class.

Parameters:

clazz - the class

Returns:

true iff. this type is the same as the given parameter

getTypeArgument

public com.squareup.javapoet.TypeName getTypeArgument(int index)

replaceParameterizedType

public com.squareup.javapoet.TypeName replaceParameterizedType(Class<?> replacementType)

Replaces the parameterized type of this type with the given replacement type.

This is useful to replace a reference type Reference<Example> with a referenceable type .

Parameters:

replacementType - the replacement type

Returns:

a new type name with the replacement type which has the same type arguments as t

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

of

public static PropertyGenModel of(ExecutableElement getterMethod)

Creates an instance from the given getter method.

Parameters:

getterMethod - the getter method

Returns:

new property model

of

public static PropertyGenModel of(String name,
                                  String jsonName,
                                  TypeMirror type,
                                  String javaDocLinkTag,
                                  boolean optional,
                                  boolean useReference)

getPropertyName

public static String getPropertyName(ExecutableElement propertyMethod)

Returns the property name of the given property method.

Parameters:

propertyMethod - the getter method

Returns:

the uncapitalized name of the property