de.espirit.firstspirit.agency

Interface TransferAgent

public interface TransferAgent

Definition for an agent providing means to produce transfer relevant objects.

Since:

4.2.426

See Also:

SpecialistsBroker

Field Summary

Fields

Modifier and Type	Field and Description
static SpecialistType<TransferAgent>	TYPE The agent's techincal type to be used to request the agent from a SpecialistsBroker.

Method Summary

Methods

Modifier and Type	Method and Description
TransferType<String>	getAllTextsType() Convenience accessor providing the transfer type representing an all text access.
TransferType<FormData>	getFormDataType() Convenience accessor providing the transfer type for FirstSpirit's FormData based data.
TransferType<String>	getHtmlTextType() Convenience accessor providing the transfer type representing an html text access.
<T extends MediaElement> TransferType<Media>	getMediaType(Class<T> clazz) Provides the transfer type for a given FirstSpirit media element type.
TransferType<Option>	getOptionType() Convenience accessor providing the transfer type for FirstSpirit's Option based data.
TransferType<String>	getPlainTextType() Convenience accessor providing the transfer type representing an plain text access.
TransferType<SegmentProvider>	getQuerySegmentType() Accessor providing he transfer type for FirstSpirit's query expressions.
TransferType<String>	getRawValueToStringType() Provides the value to string transfer type for a ValueHolder (SwingGadget).
<T> TransferType<T>	getRawValueType(Class<T> valueType) Provides the value transfer type for a ValueHolder (SwingGadget) where is the typed transfer value.
TransferType<String>	getStringType() Convenience accessor providing the transfer type for java String based data.
<T extends IDProvider> TransferType<T>	getType(Class<T> clazz) Provides the transfer type for a given FirstSpirit element type.
<T> TransferType<T>	getType(String mime, Class<T> clazz) Provides the transfer type for a given mime descriptor and the class of objects being transferred.

Field Detail

TYPE

static final SpecialistType<TransferAgent> TYPE

The agent's techincal type to be used to request the agent from a SpecialistsBroker.

Since:

4.2.426

See Also:

SpecialistsBroker.requireSpecialist(de.espirit.firstspirit.agency.SpecialistType), SpecialistsBroker.requestSpecialist(de.espirit.firstspirit.agency.SpecialistType)

Method Detail

getType

<T extends IDProvider> TransferType<T> getType(Class<T> clazz)

Provides the transfer type for a given FirstSpirit element type.

Parameters:

clazz - The FirstSpirit element class.

Returns:

The according transfer type.

Since:

4.2.426

getMediaType

<T extends MediaElement> TransferType<Media> getMediaType(Class<T> clazz)

Provides the transfer type for a given FirstSpirit media element type.

Parameters:

clazz - The media element's type.

Returns:

The according transfer type.

Since:

4.2.426

getType

<T> TransferType<T> getType(@NotNull
                          String mime,
                          @NotNull
                          Class<T> clazz)

Provides the transfer type for a given mime descriptor and the class of objects being transferred.

Parameters:

mime - The mime descriptor.

clazz - The transfer-object's class.

Returns:

The according transfer type.

Since:

4.2.426

getAllTextsType

TransferType<String> getAllTextsType()

Convenience accessor providing the transfer type representing an all text access. While using this type for registering to handle transfers, commodities provided will only be accessible by a concrete textual type (e.g. getType("text/plain", String.class)).

Returns:

The all text transfer type.

Since:

4.2.426

getPlainTextType

TransferType<String> getPlainTextType()

Convenience accessor providing the transfer type representing an plain text access. While using this type for registering to handle transfers, commodities provided will only be accessible by a concrete textual type (getType("text/plain", String.class)).

Returns:

The plain text transfer type.

Since:

5.0

getHtmlTextType

TransferType<String> getHtmlTextType()

Convenience accessor providing the transfer type representing an html text access. While using this type for registering to handle transfers, commodities provided will only be accessible by a concrete textual type (getType("text/html", String.class)).

Returns:

The plain text transfer type.

Since:

5.0

getStringType

TransferType<String> getStringType()

Convenience accessor providing the transfer type for java String based data.

Returns:

The string transfer type.

Since:

4.2.426

getRawValueType

<T> TransferType<T> getRawValueType(@NotNull
                                  Class<T> valueType)

Provides the value transfer type for a ValueHolder (SwingGadget) where is the typed transfer value.

Parameters:

valueType - The gadget value type.

Returns:

The according transfer type.

Since:

5.0

getRawValueToStringType

TransferType<String> getRawValueToStringType()

Provides the value to string transfer type for a ValueHolder (SwingGadget).

Returns:

The according transfer type.

Since:

5.0

getFormDataType

TransferType<FormData> getFormDataType()

Convenience accessor providing the transfer type for FirstSpirit's FormData based data.

Returns:

The according transfer type.

Since:

5.0

See Also:

FormData

getOptionType

TransferType<Option> getOptionType()

Convenience accessor providing the transfer type for FirstSpirit's Option based data.

Returns:

The option transfer type.

Since:

5.0.14

See Also:

Option

getQuerySegmentType

TransferType<SegmentProvider> getQuerySegmentType()

Accessor providing he transfer type for FirstSpirit's query expressions.

Returns:

The segment providing transfer type.

Since:

5.0.15

See Also:

SegmentProvider