org.threeten.bp.format

DateTimeBuilder

final class DateTimeBuilder extends TemporalAccessor with 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:

Specification for implementors

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

Creates an empty instance of the builder.

Linear Supertypes
Cloneable, Cloneable, TemporalAccessor, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DateTimeBuilder
  2. Cloneable
  3. Cloneable
  4. TemporalAccessor
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DateTimeBuilder(field: TemporalField, value: Long)

    Creates a new instance of the builder with a single field-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.

    field

    the field to add, not null

    value

    the value to add, not null

  2. new DateTimeBuilder()

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def build[R](type: TemporalQuery[R]): R

    Builds the specified type from the values in this builder.

    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.

    R

    the type to return

    type

    the type to invoke { @code from} on, not null

    returns

    the extracted value, not null

    Exceptions thrown
    DateTimeException

    if an error occurs

  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. def get(field: TemporalField): Int

    Gets the value of the specified field as an int.

    Gets the value of the specified field as an int.

    This queries the date-time for the value for the specified field. The returned value will always be within 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 and has an int range, 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.getFrom(TemporalAccessor) passing this as the argument.

    Implementations must not alter either this object.

    field

    the field to get, not null

    returns

    the value for the field, within the valid range of values

    Definition Classes
    TemporalAccessor
    Exceptions thrown
    ArithmeticException

    if numeric overflow occurs

    DateTimeException

    if the value is outside the range of valid values for the field

  13. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  14. def getLong(field: TemporalField): Long

    Gets the value of the specified field as a long.

    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.getFrom(TemporalAccessor) passing this as the argument.

    Implementations must not alter either this object.

    field

    the field to get, not null

    returns

    the value for the field

    Definition Classes
    DateTimeBuilderTemporalAccessor
    Exceptions thrown
    ArithmeticException

    if numeric overflow occurs

    DateTimeException

    if a value for the field cannot be obtained

  15. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  16. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  17. def isSupported(field: TemporalField): Boolean

    Checks if the specified field is supported.

    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(TemporalField) range and #get(TemporalField) 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.isSupportedBy(TemporalAccessor) passing this as the argument.

    Implementations must not alter this object.

    field

    the field to check, null returns false

    returns

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

    Definition Classes
    DateTimeBuilderTemporalAccessor
  18. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  19. final def notify(): Unit

    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  21. def query[R >: Null](query: TemporalQuery[R]): R

    Queries this date-time.

    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.chronology())  return // the Chrono
    if (query == TemporalQueries.precision())  return // the precision
    // call default method
    return super.query(query);
    }
    

    R

    the type of the result

    query

    the query to invoke, not null

    returns

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

    Definition Classes
    DateTimeBuilderTemporalAccessor
    Exceptions thrown
    ArithmeticException

    if numeric overflow occurs

    DateTimeException

    if unable to query

  22. def range(field: TemporalField): ValueRange

    Gets the range of valid values for the specified field.

    Gets the range of valid values for the specified field.

    All fields can be expressed as a long integer. This method returns an object that describes the valid range for that value. The value of this temporal object is used to enhance the accuracy of the returned range. If the date-time cannot return the range, because the field is unsupported or for some other reason, an exception will be thrown.

    Note that the result only describes the minimum and maximum valid values and it is important not to read too much into them. For example, there could be values within the range that are invalid for the field.

    Specification for implementors

    Implementations must check and handle all fields defined in ChronoField. If the field is supported, then the range 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.rangeRefinedBy(TemporalAccessorl) passing this as the argument.

    Implementations must not alter either this object.

    field

    the field to query the range for, not null

    returns

    the range of valid values for the field, not null

    Definition Classes
    TemporalAccessor
    Exceptions thrown
    DateTimeException

    if the range for the field cannot be obtained

  23. def resolve(resolverStyle: ResolverStyle, resolverFields: Set[TemporalField]): DateTimeBuilder

    Resolves the builder, evaluating the date and time.

    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.

    resolverStyle

    how to resolve

    returns

    { @code this}, for method chaining

  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  25. def toString(): String

    Definition Classes
    DateTimeBuilder → AnyRef → Any
  26. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Cloneable

Inherited from Cloneable

Inherited from TemporalAccessor

Inherited from AnyRef

Inherited from Any

Ungrouped