Packages

  • package root
    Definition Classes
    root
  • package java
    Definition Classes
    root
  • package time

    The main API for dates, times, instants, and durations.

    The main API for dates, times, instants, and durations.

    The classes defined here represent the principal date-time concepts, including instants, durations, dates, times, time-zones and periods. They are based on the ISO calendar system, which is the de facto world calendar following the proleptic Gregorian rules. All the classes are immutable and thread-safe.

    Each date time instance is composed of fields that are conveniently made available by the APIs. For lower level access to the fields refer to the org.threeten.bp.temporal package. Each class includes support for printing and parsing all manner of dates and times. Refer to the org.threeten.bp.format package for customization options.

    The org.threeten.bp.chrono package contains the calendar neutral API. This is intended for use by applications that need to use localized calendars. It is recommended that applications use the ISO-8601 dates and time classes from this package across system boundaries, such as to the database or across the network. The calendar neutral API should be reserved for interactions with users.

    Dates and Times

    org.threeten.bp.Instant is essentially a numeric timestamp. The current Instant can be retrieved from a org.threeten.bp.Clock. This is useful for logging and persistence of a point in time and has in the past been associated with storing the result from java.lang.System#currentTimeMillis().

    org.threeten.bp.LocalDate stores a date without a time. This stores a date like '2010-12-03' and could be used to store a birthday.

    org.threeten.bp.LocalTime stores a time without a date. This stores a time like '11:30' and could be used to store an opening or closing time.

    org.threeten.bp.LocalDateTime stores a date and time. This stores a date-time like '2010-12-03T11:30'.

    org.threeten.bp.OffsetTime stores a time and offset from UTC without a date. This stores a date like '11:30+01:00'. The ZoneOffset is of the form '+01:00'.

    org.threeten.bp.OffsetDateTime stores a date and time and offset from UTC. This stores a date-time like '2010-12-03T11:30+01:00'. This is sometimes found in XML messages and other forms of persistence, but contains less information than a full time-zone.

    org.threeten.bp.ZonedDateTime stores a date and time with a time-zone. This is useful if you want to perform accurate calculations of dates and times taking into account the org.threeten.bp.ZoneId, such as 'Europe/Paris'. Where possible, it is recommended to use a simpler class. The widespread use of time-zones tends to add considerable complexity to an application.

    Duration and Period

    Beyond dates and times, the API also allows the storage of period and durations of time. A org.threeten.bp.Duration is a simple measure of time along the time-line in nanoseconds. A org.threeten.bp.Period expresses an amount of time in units meaningful to humans, such as years or hours.

    Additional value types

    org.threeten.bp.Year stores a year on its own. This stores a single year in isolation, such as '2010'.

    org.threeten.bp.YearMonth stores a year and month without a day or time. This stores a year and month, such as '2010-12' and could be used for a credit card expiry.

    org.threeten.bp.MonthDay stores a month and day without a year or time. This stores a month and day-of-month, such as '--12-03' and could be used to store an annual event like a birthday without storing the year.

    org.threeten.bp.Month stores a month on its own. This stores a single month-of-year in isolation, such as 'DECEMBER'.

    org.threeten.bp.DayOfWeek stores a day-of-week on its own. This stores a single day-of-week in isolation, such as 'TUESDAY'.

    Definition Classes
    java
  • package format

    Provides classes to print and parse dates and times.

    Provides classes to print and parse dates and times.

    Printing and parsing is based around the DateTimeFormatter class. That class contains common formatters and factory methods. The DateTimeFormatterBuilder class is available for advanced and complex use cases.

    Localization occurs by calling withLocale(Locale) on the formatter. Further customization is possible using DecimalStyle.

    Definition Classes
    time
  • package internal
    Definition Classes
    format
  • TTBPDateTimeFormatterBuilder
  • TTBPDateTimeParseContext
  • TTBPDateTimePrintContext
  • TTBPDateTimeTextProvider
  • TTBPSimpleDateTimeTextProvider

final class TTBPDateTimePrintContext extends AnyRef

Context object used during date and time printing.

This class provides a single wrapper to items used in the print.

Specification for implementors

This class is a mutable context intended for use from a single thread. Usage of the class is thread-safe within standard printing as the framework creates a new instance of the class for each print and printing is single-threaded.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TTBPDateTimePrintContext
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TTBPDateTimePrintContext(temporal: TemporalAccessor, formatter: DateTimeFormatter)

    Creates a new instance of the context.

    Creates a new instance of the context.

    temporal

    the temporal object being output, not null

    formatter

    the formatter controlling the print, not null

  2. new TTBPDateTimePrintContext(temporal: TemporalAccessor, locale: Locale, symbols: DecimalStyle)

Value Members

  1. def endOptional(): Unit

    Ends the printing of an optional segment of the input.

  2. def getLocale: Locale

    Gets the locale.

    Gets the locale.

    This locale is used to control localization in the print output except where localization is controlled by the symbols.

    returns

    the locale, not null

  3. def getSymbols: DecimalStyle

    Gets the formatting symbols.

    Gets the formatting symbols.

    The symbols control the localization of numeric output.

    returns

    the formatting symbols, not null

  4. def getTemporal: TemporalAccessor

    Gets the temporal object being output.

    Gets the temporal object being output.

    returns

    the temporal object, not null

  5. def getValue(field: TemporalField): Long

    Gets the value of the specified field.

    Gets the value of the specified field.

    This will return the value for the specified field.

    field

    the field to find, not null

    returns

    the value, null if not found and optional is true

    Exceptions thrown

    DateTimeException if the field is not available and the section is not optional

  6. def getValue[R >: Null](query: TemporalQuery[R]): R

    Gets a value using a query.

    Gets a value using a query.

    query

    the query to use, not null

    returns

    the result, null if not found and optional is true

    Exceptions thrown

    DateTimeException if the type is not available and the section is not optional

  7. def setDateTime(temporal: TemporalAccessor): Unit

    Sets the date-time being output.

    Sets the date-time being output.

    temporal

    the date-time object, not null

  8. def setLocale(locale: Locale): Unit

    Sets the locale.

    Sets the locale.

    This locale is used to control localization in the print output except where localization is controlled by the symbols.

    locale

    the locale, not null

  9. def startOptional(): Unit

    Starts the printing of an optional segment of the input.

  10. def toString(): String

    Returns a string version of the context for debugging.

    Returns a string version of the context for debugging.

    returns

    a string representation of the context, not null

    Definition Classes
    TTBPDateTimePrintContext → AnyRef → Any