org.apache.hadoop.hive.ql.udf.generic

Interface InstantFormatter

public interface InstantFormatter

Formatter for parsing and printing Instant objects.

This interface provides the main entry point for print and parsing and provides factories for the available implementations of InstantFormatter.

The patterns that are supported and their behavior depend on the underlying implementation of the interface.

Implementations of the interface are not meant to be thread safe.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	InstantFormatter.Type Types for the built-in formatter implementations.

Method Summary

Modifier and Type	Method and Description
String	format(Instant instant) Formats the specified instant using the formatters default pattern.
String	format(Instant instant, String pattern) Formats the specified instant using the specified pattern.
static InstantFormatter	ofConfiguration(org.apache.hadoop.conf.Configuration conf) Creates a formatter using the specified configuration.
Instant	parse(String text) Parses the input text and converts it to an instant.
Instant	parse(String text, String pattern) Parses the input text and converts it to an instant using the specified pattern.

Method Detail

ofConfiguration

static InstantFormatter ofConfiguration(org.apache.hadoop.conf.Configuration conf)

Creates a formatter using the specified configuration.

Parameters:

conf - the configuration to use, not null

Returns:

the formatter based on the provided configuration, not null.

parse

Instant parse(String text)
       throws RuntimeException

Parses the input text and converts it to an instant.

Parameters:

text - the text to parse, not null

Returns:

an Instant representing a specific point in time.

Throws:

RuntimeException - if unable to parse the requested text using the default behavior.

parse

Instant parse(String text,
              String pattern)
       throws RuntimeException

Parses the input text and converts it to an instant using the specified pattern.

Parameters:

text - the text to parse, not null

pattern - the pattern to use to parse the text and resolve it to an instant

Returns:

an Instant representing a specific point in time.

Throws:

RuntimeException - if unable to parse the requested text using the specified pattern.

format

String format(Instant instant)

Formats the specified instant using the formatters default pattern.

This formats the instant to a String using the rules of the underlying formatter.

Parameters:

instant - the instant to format

Returns:

the formatted string, not null

format

String format(Instant instant,
              String pattern)

Formats the specified instant using the specified pattern.

This formats the instant to a String using specified pattern and the rules of the underlying formatter.

Parameters:

instant - the instant to format

pattern - the pattern to use for formatting

Returns:

the formatted string, not null