Package 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:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final SpecialistType<TransferAgent>
The agent's techincal type to be used to request the agent from aSpecialistsBroker
. -
Method Summary
Modifier and TypeMethodDescriptionConvenience accessor providing the transfer type representing an all text access.Convenience accessor providing the transfer type for FirstSpirit'sFormData
based data.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.Convenience accessor providing the transfer type for FirstSpirit'sOption
based data.Convenience accessor providing the transfer type representing an plain text access.Accessor providing he transfer type for FirstSpirit'squery expressions
.Provides the value to string transfer type for a ValueHolder (SwingGadget).<T> TransferType<T>
getRawValueType
(@NotNull Class<T> valueType) Provides the value transfer type for a ValueHolder (SwingGadget) where <T> is the typed transfer value.Convenience accessor providing the transfer type for javaString
based data.<T> TransferType<T>
Provides the transfer type for a given mime descriptor and the class of objects being transferred.<T extends IDProvider>
TransferType<T>Provides the transfer type for a given FirstSpirit element type.
-
Field Details
-
TYPE
The agent's techincal type to be used to request the agent from aSpecialistsBroker
.
-
-
Method Details
-
getType
Provides the transfer type for a given FirstSpirit element type.- Type Parameters:
T
- The element's type.- Parameters:
clazz
- The FirstSpirit element class.- Returns:
- The according transfer type.
- Since:
- 4.2.426
-
getMediaType
Provides the transfer type for a given FirstSpirit media element type.- Type Parameters:
T
- The element's type.- Parameters:
clazz
- The media element's type.- Returns:
- The according transfer type.
- Since:
- 4.2.426
-
getType
Provides the transfer type for a given mime descriptor and the class of objects being transferred.- Type Parameters:
T
- The transferred type.- 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 javaString
based data.- Returns:
- The string transfer type.
- Since:
- 4.2.426
-
getRawValueType
Provides the value transfer type for a ValueHolder (SwingGadget) where <T> is the typed transfer value.- Type Parameters:
T
- The transferred type.- 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'sFormData
based data.- Returns:
- The according transfer type.
- Since:
- 5.0
- See Also:
-
getOptionType
TransferType<Option> getOptionType()Convenience accessor providing the transfer type for FirstSpirit'sOption
based data.- Returns:
- The option transfer type.
- Since:
- 5.0.14
- See Also:
-
getQuerySegmentType
TransferType<SegmentProvider> getQuerySegmentType()Accessor providing he transfer type for FirstSpirit'squery expressions
.- Returns:
- The segment providing transfer type.
- Since:
- 5.0.15
- See Also:
-