Package org.refcodes.net

Class FormMediaTypeFactory

java.lang.Object

org.refcodes.net.FormMediaTypeFactory

All Implemented Interfaces:

Marshalable<java.lang.String>, MediaTypeFactory, MediaTypesAccessor, Unmarshalable<java.lang.String>

public class FormMediaTypeFactory
extends java.lang.Object
implements MediaTypeFactory

Implements the MediaTypeFactory for Media-Type "application/x-www-form-urlencoded" ( MediaType.APPLICATION_X_WWW_FORM_URLENCODED). CAUTION: This implementation can only marshal objects of (sub-)type Map of generic type String (key) and List containing String instances (value) as argument. Also supported is the derived FormFields type.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.net.MediaTypesAccessor

MediaTypesAccessor.MediaTypesBuilder<B extends MediaTypesAccessor.MediaTypesBuilder<B>>, MediaTypesAccessor.MediaTypesMutator, MediaTypesAccessor.MediaTypesProperty

Constructor Summary

Constructors

Constructor	Description
FormMediaTypeFactory()

Method Summary

Modifier and Type	Method	Description
MediaType[]	getMediaTypes()	Retrieves the Media-Types from the Media-Types property.
java.lang.String	toMarshaled(java.lang.Object aObject)	This method expects an instance of (sub-)type Map of generic type String (key) and List containing String instances (value) as argument.
<T> T	toUnmarshaled(java.lang.String aHttpBody, java.lang.Class<T> aType)	This method creates / retrieves an instance of the given type from the provided instance.

Methods inherited from interface org.refcodes.net.Marshalable

toMarshaled

Methods inherited from interface org.refcodes.net.MediaTypeFactory

fromMarshaled, fromMarshaled, fromMarshaled, fromMarshaled, fromUnmarshaled, fromUnmarshaled

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.net.Unmarshalable

toUnmarshaled, toUnmarshaled, toUnmarshaled

Constructor Detail

FormMediaTypeFactory

public FormMediaTypeFactory()

Method Detail

getMediaTypes

public MediaType[] getMediaTypes()

Retrieves the Media-Types from the Media-Types property.

Specified by:

getMediaTypes in interface MediaTypesAccessor

Returns:

The Media-Types stored by the Media-Types property.

toMarshaled

public java.lang.String toMarshaled(java.lang.Object aObject)
                             throws org.refcodes.exception.MarshalException

This method expects an instance of (sub-)type Map of generic type String (key) and List containing String instances (value) as argument. Also supported is the derived FormFields type. This method creates / retrieves an instance of the given type with the given identifier (name) constructed as defined in one to many configuration files. How the instance is configured, created or retrieved is up to the nature (implementation) of the according factory.

Specified by:

toMarshaled in interface Marshalable<java.lang.String>

Parameters:

aObject - The context which may influence the object being created by this factory.

Returns:

The instance being fabricated by this factory.

Throws:

org.refcodes.exception.MarshalException - Thrown when marshaling / serializing an object fails.

toUnmarshaled

public <T> T toUnmarshaled(java.lang.String aHttpBody,
                           java.lang.Class<T> aType)
                    throws org.refcodes.exception.UnmarshalException

Description copied from interface: Unmarshalable

This method creates / retrieves an instance of the given type from the provided instance.

Specified by:

toUnmarshaled in interface Unmarshalable<java.lang.String>

Type Parameters:

T - The type which is to be fabricated by the factory method.

Parameters:

aHttpBody - The context which may influence the object being created by this factory.

aType - The type identifying the instance to be created / retrieved.

Returns:

An instance of the required type for the given type and context.

Throws:

org.refcodes.exception.UnmarshalException - Thrown when unmarshaling / deserializing an object fails.