org.gytheio.content.transform.options

Interface TransformationSourceOptions

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractTransformationSourceOptions, CropSourceOptions, PagedSourceOptions, TemporalSourceOptions

public interface TransformationSourceOptions
extends Serializable

Defines options and demarcations needed to describe the details of how the source should be transformed, independent of the target requirements.

See PagedSourceOptions for an example implementation that describes the page number that should be used from the source content.

Author:

Ray Gauss II

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	TransformationSourceOptions.TransformationSourceOptionsSerializer Defines methods for serializing the source options into a parameter map and deserializing from a serialized options accessor.

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getApplicableMediaTypes() Gets the list of applicable media types (mimetypes)
TransformationSourceOptions.TransformationSourceOptionsSerializer	getSerializer() Gets the serializer for the source options.
boolean	isApplicableForMediaType(String mediaType) Gets whether or not these transformation source options apply for the given media type (mimetype)
TransformationSourceOptions	mergedOptions(TransformationSourceOptions overridingOptions) Creates a new TransformationSourceOptions object from this one, merging any non-null overriding fields in the given overridingOptions

Method Detail

getApplicableMediaTypes

List<String> getApplicableMediaTypes()

Gets the list of applicable media types (mimetypes)

Returns:

the applicable media types

isApplicableForMediaType

boolean isApplicableForMediaType(String mediaType)

Gets whether or not these transformation source options apply for the given media type (mimetype)

Parameters:

mediaType - the media type of the source

Returns:

if these transformation source options apply

mergedOptions

TransformationSourceOptions mergedOptions(TransformationSourceOptions overridingOptions)

Creates a new TransformationSourceOptions object from this one, merging any non-null overriding fields in the given overridingOptions

Parameters:

overridingOptions -

Returns:

a merged TransformationSourceOptions object

getSerializer

TransformationSourceOptions.TransformationSourceOptionsSerializer getSerializer()

Gets the serializer for the source options.

Returns:

the serializer