Index (jformatb-api 0.4 API)

A C D E F G H K L N O P R S T V W
All Classes and Interfaces|All Packages|Serialized Form

A

ALPHANUMERIC - Enum constant in enum class format.bind.annotation.FormatField.Type: Alphanumeric text format field.

C

converter() - Element in annotation interface format.bind.annotation.FormatMapEntryField: (Optional) The class that converts a text format field of the map entry value.
createReader() - Method in class format.bind.Formatter: Creates a new instance of FormatReader.
createReader(Class<? extends T>, String) - Method in interface format.bind.spi.FormatProcessorFactory: Creates a new instance of FormatReader for text format parsing.
createWriter() - Method in class format.bind.Formatter: Creates a new instance of FormatWriter.
createWriter(Class<? extends T>, String) - Method in interface format.bind.spi.FormatProcessorFactory: Creates a new instance of FormatWriter for Java object formatting.

D

DEFAULT - Enum constant in enum class format.bind.annotation.FormatField.Type: Inferred from property signature.
DEFAULT() - Constructor for class format.bind.annotation.FormatFieldConverter.DEFAULT

E

equals(Object) - Method in class format.bind.Formatter

F

field() - Element in annotation interface format.bind.annotation.FormatFieldOverride: (Required) The FormatField annotation with specification to apply.
field() - Element in annotation interface format.bind.annotation.FormatMapEntryField: (Required) The FormatField annotation with specification to apply.
FIELD - Enum constant in enum class format.bind.annotation.FormatAccess.Type: Field-based access is used.
FIELD - Enum constant in enum class format.bind.FormatFieldAccessor.Strategy: Used to access text format field by field (Default).
FieldConversionException - Exception in format.bind.converter: Thrown by FieldConverter when an error occurs during Java field formatting or text format field parsing.
FieldConversionException(String) - Constructor for exception format.bind.converter.FieldConversionException: Creates a new FieldConversionException with the specified detail message.
FieldConversionException(String, Throwable) - Constructor for exception format.bind.converter.FieldConversionException: Creates a new FieldConversionException with the specified detail message and cause.
FieldConverter<T> - Interface in format.bind.converter: Converts a text format field to Java type or vice versa.
FieldConverterProvider - Interface in format.bind.converter.spi: Service Provider Interface for FieldConverter.
fieldName() - Element in annotation interface format.bind.annotation.FormatMapEntryTypeInfo: (Required) The format field name of the text format field that contains the type info value.
fieldName() - Element in annotation interface format.bind.annotation.FormatTypeInfo: (Required) The format field name of the text format field that contains the type info value.
format() - Element in annotation interface format.bind.annotation.FormatField: (Optional) The format of the text format field.
format() - Method in interface format.bind.FormatFieldDescriptor: The format of the text format field.
format(FormatFieldDescriptor, T) - Method in interface format.bind.converter.FieldConverter: Converts a bound type value to a text format value.
format(T) - Method in class format.bind.Formatter: Formats the given object to produce the corresponding text format.
Format - Annotation Interface in format.bind.annotation: Specifies that the annotated element is a text format.
format.bind - package format.bind: Provides a format binding features for client applications including parsing and formatting capabilities.
format.bind.annotation - package format.bind.annotation: Provides annotations to text format binding.
format.bind.converter - package format.bind.converter: Provides text format field converter related classes.
format.bind.converter.spi - package format.bind.converter.spi: Service Provider Interface (SPI) for Java Format Binding field converters.
format.bind.spi - package format.bind.spi: Service Provider Interface (SPI) for Java Format Binding API.
FormatAccess - Annotation Interface in format.bind.annotation: Used to specify how to access text format fields.
FormatAccess.Type - Enum Class in format.bind.annotation: Used with the FormatAccess annotation to specify an access type to be applied.
FormatException - Exception in format.bind: The root class for all Format Binding exceptions.
FormatException(String) - Constructor for exception format.bind.FormatException: Creates a new FormatException with the specified detail message.
FormatException(String, Throwable) - Constructor for exception format.bind.FormatException: Creates a new FormatException with the specified detail message and cause.
FormatField - Annotation Interface in format.bind.annotation: Maps a JavaBean property to a text format field.
FormatField.Type - Enum Class in format.bind.annotation: Used in FormatField.type() to specify the type of the text format field.
FormatFieldAccessor - Interface in format.bind: Provides access to text format field properties.
FormatFieldAccessor.Strategy - Enum Class in format.bind: Defines the text format field access strategies.
FormatFieldContainer - Annotation Interface in format.bind.annotation: Indicates that the JavaBean property contains nested text format fields.
FormatFieldConverter - Annotation Interface in format.bind.annotation: Specifies a converter that implements FieldConverter for custom conversion.
FormatFieldConverter.DEFAULT - Class in format.bind.annotation: Used to signal that the converter be inferred from the signature of the property.
FormatFieldConverters - Annotation Interface in format.bind.annotation: A container for multiple FormatFieldConverter annotations.
FormatFieldDescriptor - Interface in format.bind: Represents the computed configuration of a text format field.
FormatFieldOverride - Annotation Interface in format.bind.annotation: Used to override text format fields mapped on a superclass or JavaBean properties annotated with FormatFieldContainer.
FormatFieldOverrides - Annotation Interface in format.bind.annotation: Used to override multiple text format fields mapping.
FormatMapEntries - Annotation Interface in format.bind.annotation: A container for multiple FormatMapEntry annotations.
FormatMapEntry - Annotation Interface in format.bind.annotation: Specifies the mapping for the entry value of a map.
FormatMapEntryField - Annotation Interface in format.bind.annotation: Specifies the mapping of a map entry to a text format field.
FormatMapEntryFieldContainer - Annotation Interface in format.bind.annotation: Indicates that the map entry contains nested text format fields.
FormatMapEntryFieldContainers - Annotation Interface in format.bind.annotation: A container for multiple FormatMapEntryFieldContainer annotations.
FormatMapEntryFields - Annotation Interface in format.bind.annotation: A container for multiple FormatMapEntryField annotations.
FormatMapEntryTypeInfo - Annotation Interface in format.bind.annotation: Instructs the Formatter how to find the FormatTypeValue that identifies the target Format Java type of the map entry value.
FormatMapEntryTypeInfoList - Annotation Interface in format.bind.annotation: A container for multiple FormatMapEntryTypeInfo annotations.
FormatProcessingException - Exception in format.bind: Thrown by the FormatProcessor when an error occurs during formatting Java object or parsing text format.
FormatProcessingException(String) - Constructor for exception format.bind.FormatProcessingException: Creates a new FormatProcessingException with the specified detail message.
FormatProcessingException(String, Throwable) - Constructor for exception format.bind.FormatProcessingException: Creates a new FormatProcessingException with the specified detail message and cause.
FormatProcessor<T,F extends FormatProcessor<T,F>> - Interface in format.bind: The common interface of text format processors.
FormatProcessor.Listener<T> - Interface in format.bind: A functional interface to be registered with FormatProcessor to listen for post parsing or formatting event.
FormatProcessorFactory - Interface in format.bind.spi: Factory for creating FormatReader and FormatWriter.
FormatReader<T,F extends FormatReader<T,F>> - Interface in format.bind: The FormatReader class is responsible for processing the deserialization of text format data into newly created Java type.
FormatSubTypes - Annotation Interface in format.bind.annotation: Instructs the Formatter to find the target Format.
Formatter<T> - Class in format.bind: The entry point to the format binding API.
FormatTypeInfo - Annotation Interface in format.bind.annotation: Instructs the Formatter how to find the FormatTypeValue that identifies the target Format Java type.
FormatTypeValue - Annotation Interface in format.bind.annotation: Provides the text value to identify a target Format Java type.
FormatTypeValues - Annotation Interface in format.bind.annotation: A container for multiple FormatTypeValue annotations.
FormatWriter<T,F extends FormatWriter<T,F>> - Interface in format.bind: The FormatWriter class is responsible for processing the serialization of Java object into text format.

G

getConverter(Formatter<T>) - Method in interface format.bind.converter.spi.FieldConverterProvider: Obtain the FieldConverter of the specified formatter.
getConverter(Class<T>) - Method in interface format.bind.converter.spi.FieldConverterProvider: Obtain the FieldConverter of the specified field type.
getConverter(Class<T>, Class<? extends FieldConverter<T>>) - Method in interface format.bind.converter.spi.FieldConverterProvider: Obtain the FieldConverter of the specified field type and converter type.
getFieldConverterProvider() - Method in class format.bind.Providers: Obtain the FieldConverterProvider SPI implementation.
getGenericType() - Method in interface format.bind.FormatFieldAccessor: Get the generic container type of the text format field.
getInstance() - Static method in class format.bind.Providers: Get the singleton instance if this class.
getName() - Method in interface format.bind.FormatFieldAccessor: Get the name of the text format field.
getProcessorFactory() - Method in class format.bind.Providers: Obtain the FormatProcessorFactory SPI implementation.
getType() - Method in interface format.bind.FormatFieldAccessor: Get the type of the text format field.

H

hashCode() - Method in class format.bind.Formatter

K

keys() - Element in annotation interface format.bind.annotation.FormatMapEntry: (Required) The keys of the map entry to map.
keys() - Element in annotation interface format.bind.annotation.FormatMapEntryField: (Required) The keys of the map entry to map.
keys() - Element in annotation interface format.bind.annotation.FormatMapEntryFieldContainer: (Required) The keys of the map entry to map.
keys() - Element in annotation interface format.bind.annotation.FormatMapEntryTypeInfo: (Required) The keys of the map entry to map.

L

length() - Element in annotation interface format.bind.annotation.FormatField: (Optional) The length of the text format field.
length() - Element in annotation interface format.bind.annotation.FormatMapEntryTypeInfo: (Required) The length of the text format field containing the type info value.
length() - Element in annotation interface format.bind.annotation.FormatTypeInfo: (Required) The length of the text format field containing the type info value.
length() - Method in interface format.bind.FormatFieldDescriptor: The length of the text format field.
locale() - Element in annotation interface format.bind.annotation.FormatField: (Optional) The Locale to be used with the FormatField.format() if specified.
locale() - Method in interface format.bind.FormatFieldDescriptor: The Locale to be used with the #format() if specified.
locale(String) - Method in interface format.bind.converter.FieldConverter: Returns the Locale of the given language tag

N

name() - Element in annotation interface format.bind.annotation.Format: (Optional) The name of the text format which the class is mapped.
name() - Element in annotation interface format.bind.annotation.FormatField: (Optional) The name of the text format field.
name() - Element in annotation interface format.bind.annotation.FormatFieldContainer: (Optional) The name of the text format field container.
name() - Method in interface format.bind.FormatFieldDescriptor: The name of the text format field.
NUMERIC - Enum constant in enum class format.bind.annotation.FormatField.Type: Numeric text format field.

O

of(Class<T>) - Static method in class format.bind.Formatter: Create a new instance of Formatter.

P

parse(FormatFieldDescriptor, String) - Method in interface format.bind.converter.FieldConverter: Converts a text format value to a bound type value.
parse(String) - Method in class format.bind.Formatter: Parses the given text format from the beginning to produce an object.
pattern() - Element in annotation interface format.bind.annotation.Format: (Required) The pattern of the text format which the class is mapped.
pattern() - Element in annotation interface format.bind.annotation.FormatMapEntry: (Required) The pattern of the text format of the entry value.
placeholder() - Element in annotation interface format.bind.annotation.FormatField: (Optional) The placeholder of the text format field.
placeholder() - Method in interface format.bind.FormatFieldDescriptor: The placeholder of the text format field.
postProcessing(T, Map<String, Object>) - Method in interface format.bind.FormatProcessor.Listener: Callback method invoked after reading to (parse) or writing from (format) the target parameter.
property() - Element in annotation interface format.bind.annotation.FormatFieldConverter: (Optional) The property must be specified if this annotation is used at class level.
property() - Element in annotation interface format.bind.annotation.FormatFieldOverride: (Required) The name of the property whose mapping is being overridden.
PROPERTY - Enum constant in enum class format.bind.annotation.FormatAccess.Type: Property-based access is used.
PROPERTY - Enum constant in enum class format.bind.FormatFieldAccessor.Strategy: Used to access text format field by bean property.
provider() - Static method in interface format.bind.converter.FieldConverter: Obtain the current FieldConverter service provider.
Providers - Class in format.bind: Utility class used to obtain jFormat API service provider interfaces.

R

read(String) - Method in interface format.bind.FormatReader: Deserialize text format data into the resulting Java type.
readOnly() - Element in annotation interface format.bind.annotation.FormatField: (Optional) Whether the text format field is read only.
readOnly() - Method in interface format.bind.FormatFieldDescriptor: Whether the text format field is read only.

S

scale() - Element in annotation interface format.bind.annotation.FormatField: (Optional) The scale for numeric text format field.
scale() - Method in interface format.bind.FormatFieldDescriptor: The scale for numeric text format field.
setListener(FormatProcessor.Listener<T>) - Method in interface format.bind.FormatProcessor: Register a post processing event callback FormatProcessor.Listener with this FormatProcessor.
start() - Element in annotation interface format.bind.annotation.FormatMapEntryTypeInfo: (Optional) The index of the starting point of the text format field in the whole formatted text.
start() - Element in annotation interface format.bind.annotation.FormatTypeInfo: (Optional) The index of the starting point of the text format field in the whole formatted text.

T

targetClass() - Element in annotation interface format.bind.annotation.FormatMapEntry: (Optional) The target class of the map entry value to map.
targetClass() - Element in annotation interface format.bind.annotation.FormatMapEntryField: (Optional) The target class of the map entry value to map.
targetClass() - Element in annotation interface format.bind.annotation.FormatMapEntryFieldContainer: (Optional) The target class of the map entry value to map.
toString() - Method in class format.bind.Formatter
type() - Element in annotation interface format.bind.annotation.FormatField: (Optional) The type of the text format field.
type() - Method in interface format.bind.FormatFieldDescriptor: The type of the text format field.

V

value() - Element in annotation interface format.bind.annotation.FormatAccess: (Required) Specification of field- or property-based access.
value() - Element in annotation interface format.bind.annotation.FormatFieldConverter: (Required) The class that converts a text format field value to a bound type or vice versa.
value() - Element in annotation interface format.bind.annotation.FormatFieldConverters: (Required) One or more field converters.
value() - Element in annotation interface format.bind.annotation.FormatFieldOverrides: (Required) One or more field overrides.
value() - Element in annotation interface format.bind.annotation.FormatMapEntries: (Required) One or more field map entries.
value() - Element in annotation interface format.bind.annotation.FormatMapEntryFieldContainers: (Required) One or more field map entry field containers.
value() - Element in annotation interface format.bind.annotation.FormatMapEntryFields: (Required) One or more field map entry fields.
value() - Element in annotation interface format.bind.annotation.FormatMapEntryTypeInfoList: (Required) One or more field map entry type info.
value() - Element in annotation interface format.bind.annotation.FormatSubTypes: The list of Format subclasses to include.
value() - Element in annotation interface format.bind.annotation.FormatTypeValue: (Required) The text value that identify the target Format Java type.
value() - Element in annotation interface format.bind.annotation.FormatTypeValues: The FormatTypeValue list of the Format Java type.
valueOf(String) - Static method in enum class format.bind.annotation.FormatAccess.Type: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class format.bind.annotation.FormatField.Type: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class format.bind.FormatFieldAccessor.Strategy: Returns the enum constant of this class with the specified name.
values() - Static method in enum class format.bind.annotation.FormatAccess.Type: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class format.bind.annotation.FormatField.Type: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class format.bind.FormatFieldAccessor.Strategy: Returns an array containing the constants of this enum class, in the order they are declared.

W

withListener(FormatProcessor.Listener<T>) - Method in interface format.bind.FormatProcessor: Register a post processing event callback FormatProcessor.Listener with this FormatProcessor.
withPattern(String) - Method in class format.bind.Formatter: The text format pattern of this Formatter.
write(T) - Method in interface format.bind.FormatWriter: Serialize the specified obj into a formatted text data.

A C D E F G H K L N O P R S T V W
All Classes and Interfaces|All Packages|Serialized Form