org.embulk.util.timestamp

Class TimestampFormatter.Builder

java.lang.Object

org.embulk.util.timestamp.TimestampFormatter.Builder

Enclosing class:

TimestampFormatter

public static final class TimestampFormatter.Builder
extends Object

Builds a TimestampFormatter instance with configurations.

Method Summary

Modifier and Type	Method and Description
TimestampFormatter	build() Builds TimestampFormatter from the configurations.
TimestampFormatter.Builder	setDefaultDate(int defaultYear, int defaultMonthOfYear, int defaultDayOfMonth) Sets the default date.
TimestampFormatter.Builder	setDefaultDateFromString(String defaultDateString) Sets the default date parsed from a String.
TimestampFormatter.Builder	setDefaultZoneFromString(String defaultZoneString) Sets the default timezone parsed from a String.
TimestampFormatter.Builder	setDefaultZoneId(ZoneId defaultZoneId) Sets the default ZoneId.
TimestampFormatter.Builder	setDefaultZoneOffset(ZoneOffset defaultZoneOffset) Sets the default ZoneOffset.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setDefaultZoneOffset

public TimestampFormatter.Builder setDefaultZoneOffset(ZoneOffset defaultZoneOffset)

Sets the default ZoneOffset.

Parameters:

defaultZoneOffset - the default ZoneOffset

Returns:

this

setDefaultZoneId

public TimestampFormatter.Builder setDefaultZoneId(ZoneId defaultZoneId)

Sets the default ZoneId.

Setting ZoneId is available only for a legacy non-prefixed matching pattern.

Parameters:

defaultZoneId - the default ZoneId

Returns:

this

Throws:

IllegalArgumentException - if called for a prefixed matching pattern

setDefaultZoneFromString

public TimestampFormatter.Builder setDefaultZoneFromString(String defaultZoneString)

Sets the default timezone parsed from a String.

Only for a legacy non-prefixed matching pattern, the given String is parsed into ZoneId, which accepts a geographical region such as "America/Los_Angeles" and "Asia/Tokyo". Remember that timezones based on geographical regions have problems, especially around daylight saving time, as documented in LegacyDateTimeZones.

If the pattern is prefix Ruby-style or Java-style, the given String is parsed into ZoneOffset, which is only a fixed offset. The parse is performed with ZoneOffset.of(String).

Parameters:

defaultZoneString - a String to be parsed into the default timezone

Returns:

this

Throws:

IllegalArgumentException - if called for a prefixed matching pattern

setDefaultDate

public TimestampFormatter.Builder setDefaultDate(int defaultYear,
                                                 int defaultMonthOfYear,
                                                 int defaultDayOfMonth)

Sets the default date.

Setting a default date is available only for a legacy non-prefixed matching pattern. If it is called for a prefixed Ruby-style or Java-style pattern, with a date which is not 1970-01-01, it throws IllegalArgumentException.

Calling it for a prefixed pattern is intentionally accepted with 1970-01-01 for easier migration with compatibility from Embulk's own TimestampParser.

Parameters:

defaultYear - the default year

defaultMonthOfYear - the default month of a year (1-12)

defaultDayOfMonth - the default day of a month (1-31)

Returns:

this

Throws:

IllegalArgumentException - if called for a prefixed matching pattern

setDefaultDateFromString

public TimestampFormatter.Builder setDefaultDateFromString(String defaultDateString)

Sets the default date parsed from a String.

Setting a default date is available only for a legacy non-prefixed matching pattern. If it is called for a prefixed Ruby-style or Java-style pattern, with a date which is not 1970-01-01, it throws IllegalArgumentException.

Calling it for a prefixed pattern is intentionally accepted with 1970-01-01 for easier migration with compatibility from Embulk's own TimestampParser.

Parameters:

defaultDateString - the default date in String ("YYYY-MM-DD")

Returns:

this

Throws:

IllegalArgumentException - if called for a prefixed matching pattern

build

public TimestampFormatter build()

Builds TimestampFormatter from the configurations.

Returns:

the TimestampFormatter built

Throws:

IllegalArgumentException - if invalid