net.time4j.format.expert

Interface ChronoPrinter<T>

Type Parameters:

T - generic type of chronological entity to be formatted

All Known Implementing Classes:

ChronoFormatter

public interface ChronoPrinter<T>

Prints a chronological entity.

Since:

3.0

Author:

Meno Hochschild

See Also:

ChronoEntity

Method Summary

Modifier and Type	Method and Description
default String	format(T formattable) Prints given chronological entity as formatted text.
default AttributeQuery	getAttributes() Returns the global format attributes which are active if they are not overridden by sectional attributes.
<R> R	print(T formattable, Appendable buffer, AttributeQuery attributes, ChronoFunction<ChronoDisplay,R> query) Deprecated. Beginning with v5.0, this method will be removed. Implementors are asked to override print(T, StringBuilder, AttributeQuery as soon as possible in order to simplify the future migration.
default Set<ElementPosition>	print(T formattable, StringBuilder buffer) Prints given chronological entity as formatted text and writes the text into given buffer.
default Set<ElementPosition>	print(T formattable, StringBuilder buffer, AttributeQuery attributes) Prints given chronological entity as formatted text and writes the text into given buffer.

Method Detail

print

@Deprecated
<R> R print(T formattable,
                         Appendable buffer,
                         AttributeQuery attributes,
                         ChronoFunction<ChronoDisplay,R> query)
                  throws IOException

Deprecated. Beginning with v5.0, this method will be removed. Implementors are asked to override print(T, StringBuilder, AttributeQuery as soon as possible in order to simplify the future migration.

Creates a text output and writes it into given buffer.

Note: Implementations have to call query.apply(...) at the end to return a possibly meaningful result. An example would be a query which produces just the identical input so the result of printing a Moment will be the formatted form of the original Moment.

Type Parameters:

R - generic result type

Parameters:

formattable - chronological entity to be formatted

buffer - format buffer any text output will be sent to

attributes - control attributes

query - custom query returning any kind of result

Returns:

result of query

Throws:

IllegalArgumentException - if the object is not formattable

IOException - if writing into buffer fails

format

default String format(T formattable)

Prints given chronological entity as formatted text.

Parameters:

formattable - object to be formatted

Returns:

formatted text

Throws:

IllegalArgumentException - if given object is not formattable

Since:

4.18

print

default Set<ElementPosition> print(T formattable,
                                   StringBuilder buffer)

Prints given chronological entity as formatted text and writes the text into given buffer.

Equivalent to print(formattable, buffer, getAttributes()).

Parameters:

formattable - object to be formatted

buffer - text output buffer

Returns:

unmodifiable set of element positions in formatted text, maybe empty

Throws:

IllegalArgumentException - if given object is not formattable

Since:

4.18

print

default Set<ElementPosition> print(T formattable,
                                   StringBuilder buffer,
                                   AttributeQuery attributes)

Prints given chronological entity as formatted text and writes the text into given buffer.

Starting with v5.0, this method will become the SAM-method of this interface and has to be implemented in any suitable way.

Parameters:

formattable - object to be formatted

buffer - text output buffer

attributes - format attributes which can control formatting

Returns:

unmodifiable set of element positions in formatted text, maybe empty

Throws:

IllegalArgumentException - if given object is not formattable

Since:

4.18

getAttributes

default AttributeQuery getAttributes()

Returns the global format attributes which are active if they are not overridden by sectional attributes.

Returns:

global control attributes valid for the whole formatter (can be overridden by sectional attributes however)

Since:

4.18