io.cdap.common.internal.io

Class ReflectionSchemaGenerator

java.lang.Object

io.cdap.common.internal.io.AbstractSchemaGenerator

io.cdap.common.internal.io.ReflectionSchemaGenerator

All Implemented Interfaces:

SchemaGenerator

public final class ReflectionSchemaGenerator
extends AbstractSchemaGenerator

This class uses Java Reflection to inspect fields in any Java class to generate RECORD schema.

If the given type is a class, it will uses the class fields (includes all the fields in parent classes) to generate the schema. All fields, no matter what access it is would be included, except transient or synthetic one.

If the given type is an interface, it will uses all getter methods (methods that prefix with "get" or "is", followed by a name with no arguments) to generate fields for the record schema. E.g. for the method String getFirstName(), a field name "firstName" of type String would be generated.

Constructor Summary

Constructors

Constructor and Description
ReflectionSchemaGenerator()

Method Summary

Modifier and Type	Method and Description
protected Schema	generateRecord(com.google.common.reflect.TypeToken<?> typeToken, Set<String> knowRecords, boolean acceptRecursion) Generates a RECORD schema of the given type.

Methods inherited from class io.cdap.common.internal.io.AbstractSchemaGenerator

doGenerate, generate, generate

Methods inherited from class java.lang.Object

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

Constructor Detail

ReflectionSchemaGenerator

public ReflectionSchemaGenerator()

Method Detail

generateRecord

protected Schema generateRecord(com.google.common.reflect.TypeToken<?> typeToken,
                                Set<String> knowRecords,
                                boolean acceptRecursion)
                         throws UnsupportedTypeException

Description copied from class: AbstractSchemaGenerator

Generates a RECORD schema of the given type.

Specified by:

generateRecord in class AbstractSchemaGenerator

Parameters:

typeToken - Type of the record.

knowRecords - Set of record names that schema has already been generated.

acceptRecursion - Whether to tolerate type recursion. If false, will throw UnsupportedTypeException if a recursive type is encountered.

Returns:

An instance of Schema

Throws:

UnsupportedTypeException