Time (Apache Brooklyn)

java.lang.Object
- brooklyn.util.time.Time

public class Time
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DATE_FORMAT_ISO8601`
`static java.lang.String`	`DATE_FORMAT_ISO8601_NO_MILLIS`
`static java.lang.String`	`DATE_FORMAT_OF_DATE_TOSTRING`
`static java.lang.String`	`DATE_FORMAT_PREFERRED`
`static java.lang.String`	`DATE_FORMAT_PREFERRED_W_TZ`
`static java.lang.String`	`DATE_FORMAT_SIMPLE_STAMP`
`static java.lang.String`	`DATE_FORMAT_STAMP`
`static long`	`MILLIS_IN_DAY`
`static long`	`MILLIS_IN_HOUR`
`static long`	`MILLIS_IN_MINUTE`
`static long`	`MILLIS_IN_SECOND`
`static long`	`MILLIS_IN_YEAR`
`static java.util.TimeZone`	`TIME_ZONE_UTC` GMT/UTC/Z time zone constant

Constructor Summary

Constructors
Constructor and Description

Time()

Constructors
Constructor and Description
`Time()`

Method Summary

Methods
Modifier and Type	Method and Description
`static java.util.Date`	`dropMilliseconds(java.util.Date date)` removes milliseconds from the date object; needed if serializing to ISO-8601 format and want to serialize back and get the same data
`static Duration`	`elapsedSince(long timestamp)` returns the duration elapsed since the given timestamp (UTC)
`static com.google.common.base.Function<Duration,java.lang.String>`	`fromDurationToTimeStringRounded()`
`static com.google.common.base.Function<java.lang.Long,java.lang.String>`	`fromLongToTimeStringExact()`
`static com.google.common.base.Function<java.lang.Long,java.lang.String>`	`fromLongToTimeStringRounded()`
`static long`	`getTimeOfDayFromUtc(long timeUtc)` Calculates the number of milliseconds past midnight for a given UTC time.
`static long`	`getTimeUtc(java.util.TimeZone zone, int year, int month, int date, int hourOfDay, int minute, int second, int millis)` Calculates the number of milliseconds past epoch for a given UTC time.
`static java.util.TimeZone`	`getTimeZone(java.lang.String code)`
`static Maybe<java.lang.String>`	`getTimeZoneOffsetString(java.lang.String tz, int year, int month, int day)` convert a TimeZone e.g.
`static java.lang.String`	`getTimeZoneOffsetString(java.util.TimeZone tz, int year, int month, int day)` as `getTimeZoneOffsetString(String, int, int, int)` where the `TimeZone` is already instantiated
`static boolean`	`hasElapsedSince(long timestamp, Duration duration)` true iff it has been longer than the given duration since the given timestamp
`static java.lang.String`	`makeDateSimpleStampString()` returns the current time in "yyyy-MM-dd-HHmm" format, suitable for machines to read but easier for humans too, like `makeDateStampString()` but not as precise
`static java.lang.String`	`makeDateSimpleStampString(long date)` returns the time in "yyyy-MM-dd-HHmm" format, given a long (e.g.
`static java.lang.String`	`makeDateStampString()` returns the current time in "yyyyMMdd-HHmmssSSS" format, suitable for machines to read with only numbers and dashes and quite precise (ms)
`static java.lang.String`	`makeDateStampString(long date)` returns the time in "yyyyMMdd-HHmmssSSS" format, given a long (e.g.
`static java.lang.String`	`makeDateString()` as `makeDateString(Date)` for current date/time
`static java.lang.String`	`makeDateString(java.util.Calendar date)` as `makeDateString(Date, String)` using `DATE_FORMAT_PREFERRED_W_TZ`
`static java.lang.String`	`makeDateString(java.util.Calendar date, java.lang.String format)` as `makeDateString(Date, String, TimeZone)` for the time zone of the given calendar object
`static java.lang.String`	`makeDateString(java.util.Date date)` returns the time in "yyyy-MM-dd HH:mm:ss.SSS" format for the given date; this format is numeric big-endian but otherwise optimized for people to read, with spaces and colons and dots; time is local to the server and time zone is not included
`static java.lang.String`	`makeDateString(java.util.Date date, java.lang.String format)` as `makeDateString(Date, String, TimeZone)` for the local time zone
`static java.lang.String`	`makeDateString(java.util.Date date, java.lang.String format, java.util.TimeZone tz)` as `makeDateString(Date, String, TimeZone)` for the given time zone; consider `TimeZone#GMT`
`static java.lang.String`	`makeDateString(long date)` as `makeDateString(Date)` for long millis since UTC epock
`static java.lang.String`	`makeTimeString(long t, boolean round)` given an elapsed time, makes it readable, eg 44d 6h, or 8s 923ms, optionally rounding
`static java.lang.String`	`makeTimeStringExact(Duration d)`
`static java.lang.String`	`makeTimeStringExact(long t)`
`static java.lang.String`	`makeTimeStringExact(long t, java.util.concurrent.TimeUnit unit)`
`static java.lang.String`	`makeTimeStringNano(long tn, boolean round)`
`static java.lang.String`	`makeTimeStringNanoExact(long tn)`
`static java.lang.String`	`makeTimeStringNanoRounded(long tn)`
`static java.lang.String`	`makeTimeStringRounded(Duration d)`
`static java.lang.String`	`makeTimeStringRounded(long t)`
`static java.lang.String`	`makeTimeStringRounded(long t, java.util.concurrent.TimeUnit unit)`
`static java.lang.String`	`makeTimeStringRounded(com.google.common.base.Stopwatch timer)`
`static java.lang.String`	`makeTimeStringRoundedSince(long utc)`
`static java.util.Calendar`	`newCalendarFromDate(java.util.Date date)`
`static java.util.Calendar`	`newCalendarFromMillisSinceEpochUtc(long timestamp)`
`static long`	`now()` more readable and shorter convenience for System.currentTimeMillis()
`static java.util.Calendar`	`parseCalendar(java.lang.String input)` Parses dates from string, accepting many formats including ISO-8601 and http://yaml.org/type/timestamp.html, e.g.
`static Maybe<java.util.Calendar>`	`parseCalendarFormat(java.lang.String dateString, java.text.DateFormat format)`
`static Maybe<java.util.Calendar>`	`parseCalendarFormat(java.lang.String dateString, java.lang.String format)`
`static Maybe<java.util.Calendar>`	`parseCalendarMaybe(java.lang.String input)` as `parseCalendar(String)` but returning a `Maybe` rather than throwing or returning null
`static java.util.Date`	`parseDate(java.lang.String input)` As `parseCalendar(String)` but returning a `Date`, (i.e.
`static java.util.Date`	`parseDateString(java.lang.String dateString, java.text.DateFormat format)` Deprecated. since 0.7.0 use `parseCalendar(String)` for general or `parseCalendarFormat(String, DateFormat)` for a format, plus `parseCalendarUtc(String)` if you want to accept UTC
`static Duration`	`parseDuration(java.lang.String timeString)` Convenience for `Duration.parse(String)`.
`static long`	`parseElapsedTime(java.lang.String timeString)` As `parseElapsedTimeAsDouble(String)`.
`static double`	`parseElapsedTimeAsDouble(java.lang.String timeString)` Parses a string eg '5s' or '20m 22.123ms', returning the number of milliseconds it represents; -1 on blank or never or off or false.
`static long`	`parseTimeString(java.lang.String timeString)` Deprecated. since 0.7.0 see `parseElapsedTime(String)`
`static double`	`parseTimeStringAsDouble(java.lang.String timeString)` Deprecated. since 0.7.0 see `parseElapsedTimeAsDouble(String)`
`static long`	`roundFromMillis(long millis, long millisPerUnit)`
`static long`	`roundFromMillis(long millis, java.util.concurrent.TimeUnit units)`
`static void`	`sleep(Duration duration)` as `sleep(long)`
`static void`	`sleep(long millis)` sleep which propagates Interrupted as unchecked
`static long`	`timeRemaining(long startTime, long maxTime)` Calculates how long until maxTime has passed since the given startTime.
`static com.google.common.base.Function<java.lang.Long,java.lang.String>`	`toDateStampString()`
`static com.google.common.base.Function<java.lang.Long,java.lang.String>`	`toDateString()`
`static com.google.common.base.Function<java.lang.Long,java.lang.String>`	`toTimeString()` Deprecated. since 0.7.0 use `fromLongToTimeStringExact()`
`static com.google.common.base.Function<java.lang.Long,java.lang.String>`	`toTimeStringRounded()` Deprecated. since 0.7.0 use `fromLongToTimeStringRounded()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DATE_FORMAT_PREFERRED_W_TZ
```
public static final java.lang.String DATE_FORMAT_PREFERRED_W_TZ
```
    See Also:
    Constant Field Values
  - DATE_FORMAT_PREFERRED
```
public static final java.lang.String DATE_FORMAT_PREFERRED
```
    See Also:
    Constant Field Values
  - DATE_FORMAT_STAMP
```
public static final java.lang.String DATE_FORMAT_STAMP
```
    See Also:
    Constant Field Values
  - DATE_FORMAT_SIMPLE_STAMP
```
public static final java.lang.String DATE_FORMAT_SIMPLE_STAMP
```
    See Also:
    Constant Field Values
  - DATE_FORMAT_OF_DATE_TOSTRING
```
public static final java.lang.String DATE_FORMAT_OF_DATE_TOSTRING
```
    See Also:
    Constant Field Values
  - DATE_FORMAT_ISO8601
```
public static final java.lang.String DATE_FORMAT_ISO8601
```
    See Also:
    Constant Field Values
  - DATE_FORMAT_ISO8601_NO_MILLIS
```
public static final java.lang.String DATE_FORMAT_ISO8601_NO_MILLIS
```
    See Also:
    Constant Field Values
  - MILLIS_IN_SECOND
```
public static final long MILLIS_IN_SECOND
```
    See Also:
    Constant Field Values
  - MILLIS_IN_MINUTE
```
public static final long MILLIS_IN_MINUTE
```
    See Also:
    Constant Field Values
  - MILLIS_IN_HOUR
```
public static final long MILLIS_IN_HOUR
```
    See Also:
    Constant Field Values
  - MILLIS_IN_DAY
```
public static final long MILLIS_IN_DAY
```
    See Also:
    Constant Field Values
  - MILLIS_IN_YEAR
```
public static final long MILLIS_IN_YEAR
```
    See Also:
    Constant Field Values
  - TIME_ZONE_UTC
```
public static final java.util.TimeZone TIME_ZONE_UTC
```
    GMT/UTC/Z time zone constant
- Constructor Detail
  - Time
```
public Time()
```
- Method Detail
  - makeDateString
```
public static java.lang.String makeDateString()
```
    as makeDateString(Date) for current date/time
  - makeDateString
```
public static java.lang.String makeDateString(long date)
```
    as makeDateString(Date) for long millis since UTC epock
  - makeDateString
```
public static java.lang.String makeDateString(java.util.Date date)
```
    returns the time in "yyyy-MM-dd HH:mm:ss.SSS" format for the given date; this format is numeric big-endian but otherwise optimized for people to read, with spaces and colons and dots; time is local to the server and time zone is not included
  - makeDateString
```
public static java.lang.String makeDateString(java.util.Date date,
                              java.lang.String format)
```
    as makeDateString(Date, String, TimeZone) for the local time zone
  - makeDateString
```
public static java.lang.String makeDateString(java.util.Date date,
                              java.lang.String format,
                              java.util.TimeZone tz)
```
    as makeDateString(Date, String, TimeZone) for the given time zone; consider TimeZone#GMT
  - makeDateString
```
public static java.lang.String makeDateString(java.util.Calendar date)
```
    as makeDateString(Date, String) using DATE_FORMAT_PREFERRED_W_TZ
  - makeDateString
```
public static java.lang.String makeDateString(java.util.Calendar date,
                              java.lang.String format)
```
    as makeDateString(Date, String, TimeZone) for the time zone of the given calendar object
  - toDateString
```
public static com.google.common.base.Function<java.lang.Long,java.lang.String> toDateString()
```
  - makeDateStampString
```
public static java.lang.String makeDateStampString()
```
    returns the current time in "yyyyMMdd-HHmmssSSS" format, suitable for machines to read with only numbers and dashes and quite precise (ms)
  - makeDateStampString
```
public static java.lang.String makeDateStampString(long date)
```
    returns the time in "yyyyMMdd-HHmmssSSS" format, given a long (e.g. returned by System.currentTimeMillis); cf makeDateStampString()
  - makeDateSimpleStampString
```
public static java.lang.String makeDateSimpleStampString()
```
    returns the current time in "yyyy-MM-dd-HHmm" format, suitable for machines to read but easier for humans too, like makeDateStampString() but not as precise
  - makeDateSimpleStampString
```
public static java.lang.String makeDateSimpleStampString(long date)
```
    returns the time in "yyyy-MM-dd-HHmm" format, given a long (e.g. returned by System.currentTimeMillis); cf makeDateSimpleStampString()
  - toDateStampString
```
public static com.google.common.base.Function<java.lang.Long,java.lang.String> toDateStampString()
```
  - makeTimeStringExact
```
public static java.lang.String makeTimeStringExact(long t,
                                   java.util.concurrent.TimeUnit unit)
```
    See Also:
    makeTimeString(long, boolean)
  - makeTimeStringRounded
```
public static java.lang.String makeTimeStringRounded(long t,
                                     java.util.concurrent.TimeUnit unit)
```
    See Also:
    makeTimeString(long, boolean)
  - makeTimeStringRounded
```
public static java.lang.String makeTimeStringRounded(com.google.common.base.Stopwatch timer)
```
  - makeTimeStringExact
```
public static java.lang.String makeTimeStringExact(long t)
```
    See Also:
    makeTimeString(long, boolean)
  - makeTimeStringRounded
```
public static java.lang.String makeTimeStringRounded(long t)
```
    See Also:
    makeTimeString(long, boolean)
  - makeTimeStringRoundedSince
```
public static java.lang.String makeTimeStringRoundedSince(long utc)
```
    See Also:
    makeTimeString(long, boolean)
  - makeTimeStringExact
```
public static java.lang.String makeTimeStringExact(Duration d)
```
    See Also:
    makeTimeString(long, boolean)
  - makeTimeStringRounded
```
public static java.lang.String makeTimeStringRounded(Duration d)
```
    See Also:
    makeTimeString(long, boolean)
  - makeTimeString
```
public static java.lang.String makeTimeString(long t,
                              boolean round)
```
    given an elapsed time, makes it readable, eg 44d 6h, or 8s 923ms, optionally rounding
  - makeTimeStringNanoExact
```
public static java.lang.String makeTimeStringNanoExact(long tn)
```
    See Also:
    makeTimeString(long, boolean)
  - makeTimeStringNanoRounded
```
public static java.lang.String makeTimeStringNanoRounded(long tn)
```
    See Also:
    makeTimeString(long, boolean)
  - makeTimeStringNano
```
public static java.lang.String makeTimeStringNano(long tn,
                                  boolean round)
```
    See Also:
    makeTimeString(long, boolean)
  - fromLongToTimeStringExact
```
public static com.google.common.base.Function<java.lang.Long,java.lang.String> fromLongToTimeStringExact()
```
  - toTimeString
```
@Deprecated
public static com.google.common.base.Function<java.lang.Long,java.lang.String> toTimeString()
```
    Deprecated. since 0.7.0 use fromLongToTimeStringExact()
  - fromLongToTimeStringRounded
```
public static com.google.common.base.Function<java.lang.Long,java.lang.String> fromLongToTimeStringRounded()
```
  - toTimeStringRounded
```
@Deprecated
public static com.google.common.base.Function<java.lang.Long,java.lang.String> toTimeStringRounded()
```
    Deprecated. since 0.7.0 use fromLongToTimeStringRounded()
  - fromDurationToTimeStringRounded
```
public static com.google.common.base.Function<Duration,java.lang.String> fromDurationToTimeStringRounded()
```
  - sleep
```
public static void sleep(long millis)
```
    sleep which propagates Interrupted as unchecked
  - sleep
```
public static void sleep(Duration duration)
```
    as sleep(long)
  - getTimeOfDayFromUtc
```
public static long getTimeOfDayFromUtc(long timeUtc)
```
    Calculates the number of milliseconds past midnight for a given UTC time.
  - getTimeUtc
```
public static long getTimeUtc(java.util.TimeZone zone,
              int year,
              int month,
              int date,
              int hourOfDay,
              int minute,
              int second,
              int millis)
```
    Calculates the number of milliseconds past epoch for a given UTC time.
  - roundFromMillis
```
public static long roundFromMillis(long millis,
                   java.util.concurrent.TimeUnit units)
```
  - roundFromMillis
```
public static long roundFromMillis(long millis,
                   long millisPerUnit)
```
  - timeRemaining
```
public static long timeRemaining(long startTime,
                 long maxTime)
```
    Calculates how long until maxTime has passed since the given startTime. However, maxTime==0 is a special case (e.g. could mean wait forever), so the result is guaranteed to be only 0 if maxTime was 0; otherwise -1 will be returned.
  - parseDuration
```
public static Duration parseDuration(java.lang.String timeString)
```
    Convenience for Duration.parse(String).
  - parseElapsedTime
```
public static long parseElapsedTime(java.lang.String timeString)
```
    As parseElapsedTimeAsDouble(String). Consider using parseDuration(String) for a more usable return type.
    
    Throws:
    
    java.lang.NumberFormatException - if cannot be parsed (or if null)
  - parseTimeString
```
@Deprecated
public static long parseTimeString(java.lang.String timeString)
```
    Deprecated. since 0.7.0 see parseElapsedTime(String)
  - parseTimeStringAsDouble
```
@Deprecated
public static double parseTimeStringAsDouble(java.lang.String timeString)
```
    Deprecated. since 0.7.0 see parseElapsedTimeAsDouble(String)
  - parseElapsedTimeAsDouble
```
public static double parseElapsedTimeAsDouble(java.lang.String timeString)
```
    Parses a string eg '5s' or '20m 22.123ms', returning the number of milliseconds it represents; -1 on blank or never or off or false. Assumes unit is millisections if no unit is specified.
    
    Throws:
    
    java.lang.NumberFormatException - if cannot be parsed (or if null)
  - newCalendarFromMillisSinceEpochUtc
```
public static java.util.Calendar newCalendarFromMillisSinceEpochUtc(long timestamp)
```
  - newCalendarFromDate
```
public static java.util.Calendar newCalendarFromDate(java.util.Date date)
```
  - parseDate
```
public static java.util.Date parseDate(java.lang.String input)
```
    As parseCalendar(String) but returning a Date, (i.e. a record where the time zone has been applied and forgotten).
  - parseCalendar
```
public static java.util.Calendar parseCalendar(java.lang.String input)
```
    Parses dates from string, accepting many formats including ISO-8601 and http://yaml.org/type/timestamp.html, e.g. 2015-06-15 16:00:00 +0000.
    Millis since epoch (1970) is also supported to represent the epoch (0) or dates in this millenium, but to prevent ambiguity of e.g. "20150615", any other dates prior to the year 2001 are not accepted. (However if a type Long is supplied, e.g. from a YAML parse, it will always be treated as millis since epoch.)
    Other formats including locale-specific variants, e.g. recognising month names, are supported but this may vary from platform to platform and may change between versions.
  - parseCalendarMaybe
```
public static Maybe<java.util.Calendar> parseCalendarMaybe(java.lang.String input)
```
    as parseCalendar(String) but returning a Maybe rather than throwing or returning null
  - getTimeZone
```
public static java.util.TimeZone getTimeZone(java.lang.String code)
```
  - getTimeZoneOffsetString
```
public static Maybe<java.lang.String> getTimeZoneOffsetString(java.lang.String tz,
                                              int year,
                                              int month,
                                              int day)
```
    convert a TimeZone e.g. Europe/London to an offset string as at the given day, e.g. +0100 or +0000 depending daylight savings, absent with nice error if zone unknown
  - getTimeZoneOffsetString
```
public static java.lang.String getTimeZoneOffsetString(java.util.TimeZone tz,
                                       int year,
                                       int month,
                                       int day)
```
    as getTimeZoneOffsetString(String, int, int, int) where the TimeZone is already instantiated
  - parseDateString
```
public static java.util.Date parseDateString(java.lang.String dateString,
                             java.text.DateFormat format)
```
    Deprecated. since 0.7.0 use parseCalendar(String) for general or parseCalendarFormat(String, DateFormat) for a format, plus parseCalendarUtc(String) if you want to accept UTC
    
    Parses the given date, accepting either a UTC timestamp (i.e. a long), or a formatted date.
    If no time zone supplied, this defaults to the TZ configured at the brooklyn server.
  - parseCalendarFormat
```
public static Maybe<java.util.Calendar> parseCalendarFormat(java.lang.String dateString,
                                            java.lang.String format)
```
  - parseCalendarFormat
```
public static Maybe<java.util.Calendar> parseCalendarFormat(java.lang.String dateString,
                                            java.text.DateFormat format)
```
  - dropMilliseconds
```
public static java.util.Date dropMilliseconds(java.util.Date date)
```
    removes milliseconds from the date object; needed if serializing to ISO-8601 format and want to serialize back and get the same data
  - elapsedSince
```
public static Duration elapsedSince(long timestamp)
```
    returns the duration elapsed since the given timestamp (UTC)
  - hasElapsedSince
```
public static boolean hasElapsedSince(long timestamp,
                      Duration duration)
```
    true iff it has been longer than the given duration since the given timestamp
  - now
```
public static long now()
```
    more readable and shorter convenience for System.currentTimeMillis()

Class Time

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DATE_FORMAT_PREFERRED_W_TZ

DATE_FORMAT_PREFERRED

DATE_FORMAT_STAMP

DATE_FORMAT_SIMPLE_STAMP

DATE_FORMAT_OF_DATE_TOSTRING

DATE_FORMAT_ISO8601

DATE_FORMAT_ISO8601_NO_MILLIS

MILLIS_IN_SECOND

MILLIS_IN_MINUTE

MILLIS_IN_HOUR

MILLIS_IN_DAY

MILLIS_IN_YEAR

TIME_ZONE_UTC

Constructor Detail

Time

Method Detail

makeDateString

makeDateString

makeDateString

makeDateString

makeDateString

makeDateString

makeDateString

toDateString

makeDateStampString

makeDateStampString

makeDateSimpleStampString

makeDateSimpleStampString

toDateStampString

makeTimeStringExact

makeTimeStringRounded

makeTimeStringRounded

makeTimeStringExact

makeTimeStringRounded

makeTimeStringRoundedSince

makeTimeStringExact

makeTimeStringRounded

makeTimeString

makeTimeStringNanoExact

makeTimeStringNanoRounded

makeTimeStringNano

fromLongToTimeStringExact

toTimeString

fromLongToTimeStringRounded

toTimeStringRounded

fromDurationToTimeStringRounded

sleep

sleep

getTimeOfDayFromUtc

getTimeUtc

roundFromMillis

roundFromMillis

timeRemaining

parseDuration

parseElapsedTime

parseTimeString

parseTimeStringAsDouble

parseElapsedTimeAsDouble

newCalendarFromMillisSinceEpochUtc

newCalendarFromDate

parseDate

parseCalendar

parseCalendarMaybe

getTimeZone

getTimeZoneOffsetString

getTimeZoneOffsetString

parseDateString

parseCalendarFormat

parseCalendarFormat

dropMilliseconds

elapsedSince

hasElapsedSince

now