org.threeten.bp.format

Class DateTimeBuilder

java.lang.Object

org.threeten.bp.jdk8.DefaultInterfaceTemporalAccessor

org.threeten.bp.format.DateTimeBuilder

All Implemented Interfaces:

Cloneable, TemporalAccessor

public final class DateTimeBuilder
extends DefaultInterfaceTemporalAccessor
implements TemporalAccessor, Cloneable

Builder that can holds date and time fields and related date and time objects.

The builder is used to hold onto different elements of date and time. It is designed as two separate maps:

• from TemporalField to long value, where the value may be outside the valid range for the field
• from Class to TemporalAccessor, holding larger scale objects like LocalDateTime.

Specification for implementors

This class is mutable and not thread-safe. It should only be used from a single thread.

Constructor Summary

Constructors

Constructor and Description
DateTimeBuilder() Creates an empty instance of the builder.
DateTimeBuilder(TemporalField field, long value) Creates a new instance of the builder with a single field-value.
DateTimeBuilder(ZoneId zone, Chrono<?> chrono) Creates a new instance of the builder.

Method Summary

Methods

Modifier and Type	Method and Description
DateTimeBuilder	addCalendrical(Object object) Adds a date-time object to the builder.
DateTimeBuilder	addFieldValue(TemporalField field, long value) Adds a field-value pair to the builder.
<R> R	build(Class<R> type) Builds the specified type from the values in this builder.
DateTimeBuilder	clone() Clones this builder, creating a new independent copy referring to the same map of fields and objects.
boolean	containsFieldValue(TemporalField field) Checks whether the specified field is present in the builder.
<R> R	extract(Class<?> type)
List<Object>	getCalendricalList() Gets the list of date-time objects in the builder.
long	getFieldValue(TemporalField field) Gets the value of the specified field from the builder.
Map<TemporalField,Long>	getFieldValueMap() Gets the map of field-value pairs in the builder.
long	getLong(TemporalField field) Gets the value of the specified field as a long.
long	getValidFieldValue(TemporalField field) Gets the value of the specified field from the builder ensuring it is valid.
boolean	isSupported(TemporalField field) Checks if the specified field is supported.
<R> R	query(TemporalQuery<R> query) Queries this date-time.
Long[]	queryFieldValues(TemporalField... fields) Queries a list of fields from the builder.
long	removeFieldValue(TemporalField field) Removes a field-value pair from the builder.
void	removeFieldValues(TemporalField... fields) Removes a list of fields from the builder.
DateTimeBuilder	resolve() Resolves the builder, evaluating the date and time.
String	toString()

Methods inherited from class org.threeten.bp.jdk8.DefaultInterfaceTemporalAccessor

get, range

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.threeten.bp.temporal.TemporalAccessor

get, range

Constructor Detail

DateTimeBuilder

public DateTimeBuilder()

Creates an empty instance of the builder.

DateTimeBuilder

public DateTimeBuilder(TemporalField field,
               long value)

Creates a new instance of the builder with a single field-value.

This is equivalent to using addFieldValue(TemporalField, long) on an empty builder.

Parameters:

field - the field to add, not null

value - the value to add, not null

DateTimeBuilder

public DateTimeBuilder(ZoneId zone,
               Chrono<?> chrono)

Creates a new instance of the builder.

Parameters:

zone - the zone, may be null

chrono - the chronology, may be null

Method Detail

getFieldValueMap

public Map<TemporalField,Long> getFieldValueMap()

Gets the map of field-value pairs in the builder.

Returns:

a modifiable copy of the field-value map, not null

containsFieldValue

public boolean containsFieldValue(TemporalField field)

Checks whether the specified field is present in the builder.

Parameters:

field - the field to find in the field-value map, not null

Returns:

true if the field is present

getFieldValue

public long getFieldValue(TemporalField field)

Gets the value of the specified field from the builder.

Parameters:

field - the field to query in the field-value map, not null

Returns:

the value of the field, may be out of range

Throws:

DateTimeException - if the field is not present

getValidFieldValue

public long getValidFieldValue(TemporalField field)

Gets the value of the specified field from the builder ensuring it is valid.

Parameters:

field - the field to query in the field-value map, not null

Returns:

the value of the field, may be out of range

Throws:

DateTimeException - if the field is not present

addFieldValue

public DateTimeBuilder addFieldValue(TemporalField field,
                            long value)

Adds a field-value pair to the builder.

This adds a field to the builder. If the field is not already present, then the field-value pair is added to the map. If the field is already present and it has the same value as that specified, no action occurs. If the field is already present and it has a different value to that specified, then an exception is thrown.

Parameters:

field - the field to add, not null

value - the value to add, not null

Returns:

this, for method chaining

Throws:

DateTimeException - if the field is already present with a different value

removeFieldValue

public long removeFieldValue(TemporalField field)

Removes a field-value pair from the builder.

This removes a field, which must exist, from the builder. See removeFieldValues(TemporalField...) for a version which does not throw an exception

Parameters:

field - the field to remove, not null

Returns:

the previous value of the field

Throws:

DateTimeException - if the field is not found

removeFieldValues

public void removeFieldValues(TemporalField... fields)

Removes a list of fields from the builder.

This removes the specified fields from the builder. No exception is thrown if the fields are not present.

Parameters:

fields - the fields to remove, not null

queryFieldValues

public Long[] queryFieldValues(TemporalField... fields)

Queries a list of fields from the builder.

This gets the value of the specified fields from the builder into an array where the positions match the order of the fields. If a field is not present, the array will contain null in that position.

Parameters:

fields - the fields to query, not null

Returns:

the array of field values, not null

getCalendricalList

public List<Object> getCalendricalList()

Gets the list of date-time objects in the builder.

This map is intended for use with ZoneOffset and ZoneId. The returned map is live and may be edited.

Returns:

the editable list of date-time objects, not null

addCalendrical

public DateTimeBuilder addCalendrical(Object object)

Adds a date-time object to the builder.

This adds a date-time object to the builder. If the object is a DateTimeBuilder, each field is added using addFieldValue(org.threeten.bp.temporal.TemporalField, long). If the object is not already present, then the object is added. If the object is already present and it is equal to that specified, no action occurs. If the object is already present and it is not equal to that specified, then an exception is thrown.

Parameters:

object - the object to add, not null

Returns:

this, for method chaining

Throws:

DateTimeException - if the field is already present with a different value

resolve

public DateTimeBuilder resolve()

Resolves the builder, evaluating the date and time.

This examines the contents of the builder and resolves it to produce the best available date and time, throwing an exception if a problem occurs. Calling this method changes the state of the builder.

Returns:

this, for method chaining

query

public <R> R query(TemporalQuery<R> query)

Description copied from interface: TemporalAccessor

Queries this date-time.

This queries this date-time using the specified query strategy object.

Queries are a key tool for extracting information from date-times. They exists to externalize the process of querying, permitting different approaches, as per the strategy design pattern. Examples might be a query that checks if the date is the day before February 29th in a leap year, or calculates the number of days to your next birthday.

The most common query implementations are method references, such as LocalDate::from and ZoneId::from. Further implementations are on TemporalQueries. Queries may also be defined by applications.

Specification for implementors

Implementations of this method must behave as follows:

   public <R> R query(TemporalQuery<R> type) {
     // only include an if statement if the implementation can return it
     if (query == TemporalQueries.zoneId())  return // the ZoneId
     if (query == TemporalQueries.chrono())  return // the Chrono
     if (query == TemporalQueries.precision())  return // the precision
     // call default method
     return super.query(query);
   }
 

Specified by:

query in interface TemporalAccessor

Overrides:

query in class DefaultInterfaceTemporalAccessor

Type Parameters:

R - the type of the result

Parameters:

query - the query to invoke, not null

Returns:

the query result, null may be returned (defined by the query)

extract

public <R> R extract(Class<?> type)

build

public <R> R build(Class<R> type)

Builds the specified type from the values in this builder.

This attempts to build the specified type from this builder. If the builder cannot return the type, an exception is thrown.

Type Parameters:

R - the type to return

Parameters:

type - the type to invoke from on, not null

Returns:

the extracted value, not null

Throws:

DateTimeException - if an error occurs

clone

public DateTimeBuilder clone()

Clones this builder, creating a new independent copy referring to the same map of fields and objects.

Overrides:

clone in class Object

Returns:

the cloned builder, not null

toString

public String toString()

Overrides:

toString in class Object

isSupported

public boolean isSupported(TemporalField field)

Description copied from interface: TemporalAccessor

Checks if the specified field is supported.

This checks if the date-time can be queried for the specified field. If false, then calling the range and get methods will throw an exception.

Specification for implementors

Implementations must check and handle all fields defined in ChronoField. If the field is supported, then true is returned, otherwise false

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.doIsSupported(TemporalAccessor) passing this as the argument.

Implementations must not alter either this object.

Specified by:

isSupported in interface TemporalAccessor

Parameters:

field - the field to check, null returns false

Returns:

true if this date-time can be queried for the field, false if not

getLong

public long getLong(TemporalField field)

Description copied from interface: TemporalAccessor

Gets the value of the specified field as a long.

This queries the date-time for the value for the specified field. The returned value may be outside the valid range of values for the field. If the date-time cannot return the value, because the field is unsupported or for some other reason, an exception will be thrown.

Specification for implementors

Implementations must check and handle all fields defined in ChronoField. If the field is supported, then the value of the field must be returned. If unsupported, then a DateTimeException must be thrown.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.doGet(TemporalAccessor) passing this as the argument.

Implementations must not alter either this object.

Specified by:

getLong in interface TemporalAccessor

Parameters:

field - the field to get, not null

Returns:

the value for the field