com.google.template.soy.data

Interface SoyCustomValueConverter

All Known Implementing Classes:

SoyProtoValueConverter

public interface SoyCustomValueConverter

Important: Until this API is more stable and this note is removed, users must not directly use this class.

A custom converter that knows how to convert some specific Java objects to SoyValues (or SoyValueProviders).

TODO(user): Going away soon. Please perform data conversions outside of Soy code.

Method Summary

Modifier and Type	Method and Description
SoyValueProvider	convert(SoyValueConverter valueConverter, Object obj) Converts the given object into a corresponding SoyValue or SoyValueProvider.

Method Detail

convert

SoyValueProvider convert(SoyValueConverter valueConverter,
                         Object obj)

Converts the given object into a corresponding SoyValue or SoyValueProvider. If this converter is not intended to handle the given object, then returns null.

Parameters:

valueConverter - The converter to use for internal arbitrary object conversions (if needed). This should be a general converter that knows how to handle all object types.

obj - The object to convert.

Returns:

A provider for the converted value (often the converted value itself).