net.time4j.format

Interface TextElement<V>

Type Parameters:

V - generic type of element values

All Superinterfaces:

ChronoElement<V>, Comparator<ChronoEntity<?>>

public interface TextElement<V>
extends ChronoElement<V>

A chronological element which can be formatted as text or can be parsed from a text.

Author:

Meno Hochschild

Method Summary

Methods

Modifier and Type	Method and Description
V	parse(CharSequence text, ParseLog status, AttributeQuery attributes) Interpretes the given text as element value.
void	print(ChronoEntity<?> context, Appendable buffer, AttributeQuery attributes) Converts the element value in given context to a formatted text.

Methods inherited from interface net.time4j.engine.ChronoElement

compare, getDefaultMaximum, getDefaultMinimum, getSymbol, getType, isDateElement, isLenient, isTimeElement, name

Methods inherited from interface java.util.Comparator

equals

Method Detail

print

void print(ChronoEntity<?> context,
         Appendable buffer,
         AttributeQuery attributes)
           throws IOException

Converts the element value in given context to a formatted text.

Implementation note: The concrete element value is obtainable by the expression context.get(this).

Parameters:

context - time context with the value of this element

buffer - format buffer any text output will be sent to

attributes - query for control attributes

Throws:

IOException - if writing to buffer fails

parse

V parse(CharSequence text,
      ParseLog status,
      AttributeQuery attributes)

Interpretes the given text as element value.

Implementation note: Any implementation will start first at the position status.getPosition() and either set the new position after successful parsing or return null in case of error.

Parameters:

text - text to be parsed

status - current parsing position

attributes - query for control attributes

Returns:

parsed element value or null if parsing was not successful