retrofit.processor

Class RetrofitProcessor.Property

java.lang.Object

retrofit.processor.RetrofitProcessor.Property

Enclosing class:

RetrofitProcessor

public static class RetrofitProcessor.Property
extends java.lang.Object

A property of an @Retrofit class, defined by one of its abstract methods. An instance of this class is made available to the Velocity template engine for each property. The public methods of this class define JavaBeans-style properties that are accessible from templates. For example getType() means we can write $p.type for a Velocity variable $p that is a Property.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	converter
java.lang.String	errorHandler
java.lang.String	gsonConverter
java.lang.String	logLevel
java.lang.String	requestInterceptor

Method Summary

Modifier and Type	Method and Description
java.lang.String	buildBody(javax.lang.model.element.ExecutableElement method)
java.util.Map<java.lang.String,java.lang.String>	buildFields(javax.lang.model.element.ExecutableElement method)
java.util.Map<java.lang.String,java.lang.String>	buildHeaders(javax.lang.model.element.ExecutableElement method)
boolean	buildIsAuthenticated(javax.lang.model.element.ExecutableElement method)
boolean	buildIsDelete(javax.lang.model.element.ExecutableElement method)
boolean	buildIsGet(javax.lang.model.element.ExecutableElement method)
boolean	buildIsHead(javax.lang.model.element.ExecutableElement method)
boolean	buildIsPost(javax.lang.model.element.ExecutableElement method)
boolean	buildIsPut(javax.lang.model.element.ExecutableElement method)
boolean	buildIsSingletonRequestInterceptor(javax.lang.model.element.ExecutableElement method)
java.util.Map<java.lang.String,RetrofitProcessor.Part>	buildParts(javax.lang.model.element.ExecutableElement method)
java.lang.String	buildPath(javax.lang.model.element.ExecutableElement method)
java.util.List<java.lang.String>	buildPermissions(javax.lang.model.element.ExecutableElement method)
java.util.Map<java.lang.String,java.lang.String>	buildQueries(javax.lang.model.element.ExecutableElement method)
java.util.List<java.lang.String>	buildQueryBundles(javax.lang.model.element.ExecutableElement method)
java.util.List<java.lang.String>	buildQueryMaps(javax.lang.model.element.ExecutableElement method)
java.lang.String	buildRawPath(javax.lang.model.element.ExecutableElement method)
java.lang.String	getAccess()
java.util.List<java.lang.String>	getAnnotations()
java.lang.String	getArgs()
java.lang.String	getBody()
java.lang.String	getCallbackArg()
java.lang.String	getCallbackName()
java.lang.String	getCallbackType()
java.lang.String	getCastType()
java.lang.String	getConverter()
java.lang.String	getErrorHandler()
java.util.Map<java.lang.String,java.lang.String>	getFields()
java.lang.String	getGetter() Returns the name of the getter method for this property as defined by the @Retrofit class.
java.lang.String	getGsonConverter()
java.util.Map<java.lang.String,java.lang.String>	getHeaders()
javax.lang.model.type.TypeKind	getKind()
java.lang.String	getLogLevel()
java.lang.String	getName() Returns the name of the property as it should be used in strings visible to users.
java.util.Map<java.lang.String,RetrofitProcessor.Part>	getParts()
java.lang.String	getPath()
java.util.List<java.lang.String>	getPermissions()
java.util.Map<java.lang.String,java.lang.String>	getQueries()
java.util.List<java.lang.String>	getQueryBundles()
java.util.List<java.lang.String>	getQueryMaps()
java.lang.String	getRequestInterceptor()
java.lang.String	getType()
java.lang.String	getTypeArgs()
java.lang.String	getTypeArgs2()
boolean	isAuthenticated()
boolean	isBlocking()
boolean	isCallback()
boolean	isDelete()
boolean	isGet()
boolean	isHead()
boolean	isNullable()
boolean	isObservable()
boolean	isPost()
boolean	isPut()
boolean	isResponseType()
boolean	isSingletonRequestInterceptor()
boolean	isVoid()
boolean	primitive()
java.lang.String	toString() Returns the name of the property as it should be used when declaring identifiers (fields and parameters).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

converter

public final java.lang.String converter

gsonConverter

public java.lang.String gsonConverter

errorHandler

public final java.lang.String errorHandler

logLevel

public final java.lang.String logLevel

requestInterceptor

public final java.lang.String requestInterceptor

Method Detail

buildIsGet

public boolean buildIsGet(javax.lang.model.element.ExecutableElement method)

buildIsPost

public boolean buildIsPost(javax.lang.model.element.ExecutableElement method)

buildIsPut

public boolean buildIsPut(javax.lang.model.element.ExecutableElement method)

buildIsDelete

public boolean buildIsDelete(javax.lang.model.element.ExecutableElement method)

buildIsHead

public boolean buildIsHead(javax.lang.model.element.ExecutableElement method)

buildIsAuthenticated

public boolean buildIsAuthenticated(javax.lang.model.element.ExecutableElement method)

buildIsSingletonRequestInterceptor

public boolean buildIsSingletonRequestInterceptor(javax.lang.model.element.ExecutableElement method)

buildBody

public java.lang.String buildBody(javax.lang.model.element.ExecutableElement method)

buildPermissions

public java.util.List<java.lang.String> buildPermissions(javax.lang.model.element.ExecutableElement method)

buildHeaders

public java.util.Map<java.lang.String,java.lang.String> buildHeaders(javax.lang.model.element.ExecutableElement method)

buildFields

public java.util.Map<java.lang.String,java.lang.String> buildFields(javax.lang.model.element.ExecutableElement method)

buildParts

public java.util.Map<java.lang.String,RetrofitProcessor.Part> buildParts(javax.lang.model.element.ExecutableElement method)

buildPath

public java.lang.String buildPath(javax.lang.model.element.ExecutableElement method)

buildRawPath

public java.lang.String buildRawPath(javax.lang.model.element.ExecutableElement method)

buildQueries

public java.util.Map<java.lang.String,java.lang.String> buildQueries(javax.lang.model.element.ExecutableElement method)

buildQueryMaps

public java.util.List<java.lang.String> buildQueryMaps(javax.lang.model.element.ExecutableElement method)

buildQueryBundles

public java.util.List<java.lang.String> buildQueryBundles(javax.lang.model.element.ExecutableElement method)

toString

public java.lang.String toString()

Returns the name of the property as it should be used when declaring identifiers (fields and parameters). If the original getter method was foo() then this will be foo. If it was getFoo() then it will be foo. If it was getPackage() then it will be something like package0, since package is a reserved word.

Overrides:

toString in class java.lang.Object

getName

public java.lang.String getName()

Returns the name of the property as it should be used in strings visible to users. This is usually the same as toString(), except that if we had to use an identifier like "package0" because "package" is a reserved word, the name here will be the original "package".

getGetter

public java.lang.String getGetter()

Returns the name of the getter method for this property as defined by the @Retrofit class. For property foo, this will be foo or getFoo or isFoo.

getType

public java.lang.String getType()

getTypeArgs

public java.lang.String getTypeArgs()

getTypeArgs2

public java.lang.String getTypeArgs2()

getKind

public javax.lang.model.type.TypeKind getKind()

getCastType

public java.lang.String getCastType()

primitive

public boolean primitive()

isCallback

public boolean isCallback()

getCallbackType

public java.lang.String getCallbackType()

getCallbackArg

public java.lang.String getCallbackArg()

getCallbackName

public java.lang.String getCallbackName()

isObservable

public boolean isObservable()

isVoid

public boolean isVoid()

isBlocking

public boolean isBlocking()

isResponseType

public boolean isResponseType()

getBody

public java.lang.String getBody()

getConverter

public java.lang.String getConverter()

getGsonConverter

public java.lang.String getGsonConverter()

getErrorHandler

public java.lang.String getErrorHandler()

getRequestInterceptor

public java.lang.String getRequestInterceptor()

getLogLevel

public java.lang.String getLogLevel()

getPermissions

public java.util.List<java.lang.String> getPermissions()

isGet

public boolean isGet()

isPut

public boolean isPut()

isPost

public boolean isPost()

isDelete

public boolean isDelete()

isHead

public boolean isHead()

isAuthenticated

public boolean isAuthenticated()

isSingletonRequestInterceptor

public boolean isSingletonRequestInterceptor()

getAnnotations

public java.util.List<java.lang.String> getAnnotations()

getArgs

public java.lang.String getArgs()

getPath

public java.lang.String getPath()

getQueries

public java.util.Map<java.lang.String,java.lang.String> getQueries()

getQueryMaps

public java.util.List<java.lang.String> getQueryMaps()

getQueryBundles

public java.util.List<java.lang.String> getQueryBundles()

getHeaders

public java.util.Map<java.lang.String,java.lang.String> getHeaders()

getFields

public java.util.Map<java.lang.String,java.lang.String> getFields()

getParts

public java.util.Map<java.lang.String,RetrofitProcessor.Part> getParts()

isNullable

public boolean isNullable()

getAccess

public java.lang.String getAccess()