com.googlecode.objectify.impl.translate

Interface TranslatorFactory<T>

All Known Implementing Classes:

ArrayTranslatorFactory, AsIsTranslatorFactory, BigDecimalLongTranslatorFactory, BigMoneyStringTranslatorFactory, ByteArrayTranslatorFactory, CollectionTranslatorFactory, DateTimeZoneTranslatorFactory, EmbedClassTranslatorFactory, EnumTranslatorFactory, KeyTranslatorFactory, LocalDateTimeTranslatorFactory, LocalDateTranslatorFactory, LocalTimeTranslatorFactory, MapifyTranslatorFactory, MapTranslatorFactory, MoneyStringTranslatorFactory, NumberTranslatorFactory, ReadableInstantTranslatorFactory, RefTranslatorFactory, SerializeTranslatorFactory, SqlDateTranslatorFactory, StringTranslatorFactory, TextTranslatorFactory, TimeZoneTranslatorFactory, TranslateTranslatorFactory, URLTranslatorFactory, ValueTranslatorFactory

public interface TranslatorFactory<T>

A translator knows how to load an entity Node subgraph into a POJO object. When an entity class is registered, the known TranslatorFactories are queried to produce Translator objects for each field. These translators are permanently associated with the entity metadata so they do not need to be discovered at normal runtime.

Translators are composed of other translators; through a chain of these a whole entity object is assembled or disassembled. Factories can use CreateContext.getFactory().getTranslators() to create these nested translator instances for component types.

Author:

Jeff Schnitzer

Method Summary

Methods

Modifier and Type	Method and Description
Translator<T>	create(Path path, Property property, Type type, CreateContext ctx)

Method Detail

create

Translator<T> create(Path path,
                   Property property,
                   Type type,
                   CreateContext ctx)

Parameters:

path - current path to this part of the tree, important for logging and exceptions

property - is the property we are inspecting to create a translator for

type - is the generic type of the field (or field component). For example, examining a field of type List will have a Type of List; the TranslatorFactory which recognizes List may then ask for a translator of its component type String.

Returns:

null if this factory does not know how to deal with that situation.