com.expedia.tesla.compiler.plugins

Class JavaTypeMapper

java.lang.Object

com.expedia.tesla.compiler.plugins.JavaTypeMapper

public class JavaTypeMapper
extends Object

Constructor Summary

Constructors

Constructor and Description
JavaTypeMapper()

Method Summary

Methods

Modifier and Type	Method and Description
String	box(String t) Get the boxed type name.
Type	fromJavaClass(Schema.SchemaBuilder schemaBuilder, Class<?> javaType) Generate Tesla schema from Java class by reflection.
JavaTypeDescriptor	getTypeDescriptor(Type t) Obtains Java type descriptor which describes type mapping information for a given Tesla type.
boolean	isMapToJavaArray() Determines if Tesla arrays are mapped to Java arrays.
void	setMapToJavaArray(boolean mapToJavaArray) Configures the default Tesla array mapping when an array type specified without detailed container type information.
String	symbol(Type t) Create an unique symbol for a Tesla type that can be used in the generated source code.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaTypeMapper

public JavaTypeMapper()

Method Detail

isMapToJavaArray

public boolean isMapToJavaArray()

Determines if Tesla arrays are mapped to Java arrays. If this is true, Tesla arrays without detailed container type information will be mapped to java arrays. Otherwise, they will be mapped to ArrayList.

Returns:

true if map to Java array; false otherwise.

setMapToJavaArray

public void setMapToJavaArray(boolean mapToJavaArray)

Configures the default Tesla array mapping when an array type specified without detailed container type information.

Set to true will map arrays to Java arrays. Otherwise, they will be mapped to ArrayList.

Parameters:

mapToJavaArray - if map to Java array;

getTypeDescriptor

public JavaTypeDescriptor getTypeDescriptor(Type t)
                                     throws TeslaSchemaException

Obtains Java type descriptor which describes type mapping information for a given Tesla type.

Parameters:

t - The Tesla type.

Returns:

A JavaTypeDescriptor object that describes the mapped Java types.

Throws:

TeslaSchemaException - On a mapping error.

symbol

public String symbol(Type t)

Create an unique symbol for a Tesla type that can be used in the generated source code.

Parameters:

t - The Tesla type.

Returns:

An unique symbol for a Tesla type that can be used in the generated source code.

box

public String box(String t)

Get the boxed type name. If the input type name does't represent a Java primitive type, the returned value will be the same as input.

Parameters:

t - Java type name.

Returns:

The boxed Java type name if the input is a Java primitive type. Otherwise, it returns the same name as input.

fromJavaClass

public Type fromJavaClass(Schema.SchemaBuilder schemaBuilder,
                 Class<?> javaType)
                   throws TeslaSchemaException

Generate Tesla schema from Java class by reflection.

Tesla can generate schema from existing Java classes that follow the JavaBeans Spec. Only properties with following attributes will be included:

public accessible. writable (has both getter and setter). has no SkipField annotation.

Tesla will map Java type to it's closest Tesla type by default. Developers can override this by either providing their own TypeMapper, or with Tesla annoations.

Tesla will map all Java object types to nullable types only for class properties. If you want an property to be not nullable, use annotation NotNullable.

Parameters:

schemaBuilder - All non-primitive Tesla types must be defined inside a schema. This is the schema object into which the Tesla type will be generated.

javaType - The java class object.

Returns:

The Tesla type created from the java class by reflection.

Throws:

TeslaSchemaException