net.time4j.format

Interface FormatEngine<P extends ChronoPattern<P>>

Type Parameters:

P - generic type of applicable format patterns

public interface FormatEngine<P extends ChronoPattern<P>>

This SPI-interface allows the creation of temporal formats via a builder-approach.

Since:

3.0

Author:

Meno Hochschild

Specification:

Implementations must have a public no-arg constructor.

Method Summary

Modifier and Type	Method and Description
<T extends ChronoEntity<T>> TemporalFormatter<T>	create(Class<T> chronoType, String formatPattern, P patternType, Locale locale) Creates a new temporal format object applicable on given chronological type.
TemporalFormatter<? extends UniversalTime>	createRFC1123() Creates a specialized formatter for RFC-1123.
P	getDefaultPatternType() Yields the default pattern type.
boolean	isSupported(Class<?> chronoType) Helps to find out if given chronological type is supported.

Method Detail

create

<T extends ChronoEntity<T>> TemporalFormatter<T> create(Class<T> chronoType,
                                                        String formatPattern,
                                                        P patternType,
                                                        Locale locale)

Creates a new temporal format object applicable on given chronological type.

Type Parameters:

T - generic chronological type

Parameters:

chronoType - chronological type any creatable format must work with

formatPattern - pattern of symbols to be used in formatting and parsing

patternType - type of pattern how to interprete symbols

locale - language and regional setting

Returns:

temporal format object

Throws:

IllegalArgumentException - if given chronological type is not formattable

Since:

3.0

createRFC1123

TemporalFormatter<? extends UniversalTime> createRFC1123()

Creates a specialized formatter for RFC-1123.

Returns:

temporal format object

Since:

3.0

getDefaultPatternType

P getDefaultPatternType()

Yields the default pattern type.

Returns:

ChronoPattern

Since:

3.0

isSupported

boolean isSupported(Class<?> chronoType)

Helps to find out if given chronological type is supported.

Parameters:

chronoType - chronological type to be queried

Returns:

true if given type is formattable else false

Since:

3.0