com.phoenixnap.oss.ramlapisync.data

Class ApiParameterMetadata

java.lang.Object

com.phoenixnap.oss.ramlapisync.data.ApiParameterMetadata

public class ApiParameterMetadata
extends Object

Data object containing information kept at runtime for Api Call Parameters. This class is used by the RAML generator and serves as a middle layer to store information extracted from the source in a way that makes sense to the generator

Since:

0.0.1

Author:

Kurt Paris

Constructor Summary

Constructors

Constructor and Description
ApiParameterMetadata(Parameter param) Default constructor that creates a metadata object from a Java parameter
ApiParameterMetadata(String name, RamlAbstractParam param) Default constructor that creates a metadata object from a Raml parameter

Method Summary

Modifier and Type	Method and Description
String	getExample() The example which is set with this parameter
Type	getGenericType() The Java Type of the generic portion of the parameter
String	getJavaName() Gets the name of the parameter as specified in Java (ignores any annotations)
String	getName() The Parameter Name in RAML
RamlAbstractParam	getRamlParam()
Class<?>	getType() The Java Type of the parameter
boolean	isAnnotationPresent(Class<? extends Annotation> annotationClass) Checks if the param is annotated by a particular annotation
boolean	isArray() Quick check to see if this is an array type or not
boolean	isNullable() Can this parameter be passed in as null
boolean	isResourceId() Is this parameter the identifying parameter to the rest resource.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiParameterMetadata

public ApiParameterMetadata(String name,
                            RamlAbstractParam param)

Default constructor that creates a metadata object from a Raml parameter

Parameters:

name - The name of this parameter if different in annotation

param - Java Parameter representation

ApiParameterMetadata

public ApiParameterMetadata(Parameter param)

Default constructor that creates a metadata object from a Java parameter

Parameters:

param - Java Parameter representation

Method Detail

getType

public Class<?> getType()

The Java Type of the parameter

Returns:

The Java Type of the parameter

getGenericType

public Type getGenericType()

The Java Type of the generic portion of the parameter

Returns:

The Java Type of the generic portion of the parameter

isNullable

public boolean isNullable()

Can this parameter be passed in as null

Returns:

boolean which if false means this parameter cannot be null

isResourceId

public boolean isResourceId()

Is this parameter the identifying parameter to the rest resource. If true then this parameter should end up as part of the URL

Returns:

a boolean which if true implies that this parameter is part of the url/id of the resource

getName

public String getName()

The Parameter Name in RAML

Returns:

String with the parameter name

getJavaName

public String getJavaName()

Gets the name of the parameter as specified in Java (ignores any annotations)

Returns:

string with the variable name of this parameter

isAnnotationPresent

public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass)

Checks if the param is annotated by a particular annotation

Parameters:

annotationClass - The type of the Annotation required

Returns:

true if this parameter has the annotation required

getExample

public String getExample()

The example which is set with this parameter

Returns:

String showing example usage of this parameter

toString

public String toString()

Overrides:

toString in class Object

getRamlParam

public RamlAbstractParam getRamlParam()

isArray

public boolean isArray()

Quick check to see if this is an array type or not

Returns: