Timestamp (Concourse Java API)

Object
- Timestamp

All Implemented Interfaces:

Comparable<Timestamp>
```
@Immutable
 @ThreadSafe
public final class Timestamp
extends Object
implements Comparable<Timestamp>
```
A wrapper class for a Unix timestamp with microsecond precision. A Timestamp is required for historical operations in Concourse. This class provides interoperability with Joda DateTime objects with the fromJoda(DateTime) and getJoda() methods.

Field Summary

Fields
Modifier and Type	Field and Description
`static DateTimeFormatter`	`DEFAULT_DATE_ONLY_FORMATTER` The default formatter that is used to display `date only` timestamps.
`static DateTimeFormatter`	`DEFAULT_FORMATTER` The default formatter that is used to display objects of this class.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Timestamp other)`
`static Timestamp`	`epoch()` Return a `Timestamp` that corresponds to the system epoch timestamp with microsecond precision.
`boolean`	`equals(Object obj)`
`static Timestamp`	`fromInstant(Instant instant)` Return a `Timestamp` that corresponds to the specified `instant`.
`static Timestamp`	`fromJoda(DateTime joda)` Return the `Timestamp` that corresponds to the provided joda DateTime object.
`static Timestamp`	`fromMicros(long microseconds)` Return a `Timestamp` that corresponds to the provided Unix timestamp with microsecond precision.
`static Timestamp`	`fromString(String description)` Take the `description` and return a `Timestamp` that can be passed to `driver` API methods.
`Instant`	`getInstant()` Return an `Instant` that corresponds to the point on the time-line represented by this `Timestamp`.
`DateTime`	`getJoda()` Return the Joda `DateTime` object that corresponds to this Timestamp.
`long`	`getMicros()` Return the number of microseconds since the Unix epoch that is represented by this Timestamp.
`int`	`hashCode()`
`boolean`	`isDateOnly()` Return `true` of this `Timestamp` does not have relevant temporal componet.
`static Timestamp`	`now()` Return a `Timestamp` set the current system microsecond time using `ISOChronology` in the default time zone.
`static Timestamp`	`now(Chronology chronology)` Return a `Timestamp` set to the current system microsecond time using the specified chronology.
`static Timestamp`	`now(DateTimeZone zone)` Return a `Timestamp` set to the current system microsecond time using `ISOChronology` in the specified time zone.
`static Timestamp`	`parse(String str, DateTimeFormatter formatter)` Parses a `Timestamp` from the specified string using a formatter.
`static Timestamp`	`parse(String str, String format)` Parse a `Timestamp` from the specified string that adheres to the provided `format`.
`String`	`toString()`

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_DATE_ONLY_FORMATTER
```
public static final DateTimeFormatter DEFAULT_DATE_ONLY_FORMATTER
```
    The default formatter that is used to display date only timestamps.
  - DEFAULT_FORMATTER
```
public static final DateTimeFormatter DEFAULT_FORMATTER
```
    The default formatter that is used to display objects of this class.
- Method Detail
  - epoch
```
public static Timestamp epoch()
```
    Return a Timestamp that corresponds to the system epoch timestamp with microsecond precision.
    
    Returns:
    
    the timestamp for system epoch
  - fromInstant
```
public static Timestamp fromInstant(Instant instant)
```
    Return a Timestamp that corresponds to the specified instant.
    
    Parameters:
    
    instant - an instance
    
    Returns:
    
    the corresponding Timestamp
  - fromJoda
```
public static Timestamp fromJoda(DateTime joda)
```
    Return the Timestamp that corresponds to the provided joda DateTime object.
    
    Parameters:
    
    joda - a DateTime object
    
    Returns:
    
    the timestamp for joda
  - fromMicros
```
public static Timestamp fromMicros(long microseconds)
```
    Return a Timestamp that corresponds to the provided Unix timestamp with microsecond precision.
    
    Parameters:
    
    microseconds - the number of microseconds since the Unix epoch
    
    Returns:
    
    the timestamp for microseconds
  - fromString
```
public static Timestamp fromString(String description)
```
    Take the description and return a Timestamp that can be passed to driver API methods.
    Timestamp description are parsed by Concourse Server, so this method only returns a wrapper that is meant to be passed over the wire. Timestamps returned from this method are non-operable and will throw exceptions if you call methods that would return a precise instant (i.e. getJoda() or getMicros()).
    
    Parameters:
    
    description - a relative or absolute natural language description of an instant.
    
    Returns:
    
    a hollow Timestamp that wraps the description
  - now
```
public static Timestamp now()
```
    Return a Timestamp set the current system microsecond time using ISOChronology in the default time zone.
    
    Returns:
    
    the current timestamp, not null
  - now
```
public static Timestamp now(Chronology chronology)
```
    Return a Timestamp set to the current system microsecond time using the specified chronology.
    
    Parameters:
    
    chronology - the chronology, not null
    
    Returns:
    
    the current timestamp, not null
  - now
```
public static Timestamp now(DateTimeZone zone)
```
    Return a Timestamp set to the current system microsecond time using ISOChronology in the specified time zone.
    
    Parameters:
    
    zone - the time zone, not null
    
    Returns:
    
    the current timestamp, not null
  - parse
```
public static Timestamp parse(String str,
                              DateTimeFormatter formatter)
```
    Parses a Timestamp from the specified string using a formatter.
    
    Parameters:
    
    str - the string to parse, not null
    
    formatter - the formatter to use, not null
    
    Returns:
    
    the parsed timestamp
  - parse
```
public static Timestamp parse(String str,
                              String format)
```
    Parse a Timestamp from the specified string that adheres to the provided format.
    
    Parameters:
    
    str - the string to parse, not null
    
    format - the format of the string; see http://www.joda.org/joda-time/apidocs/org/joda/time/format/DateTimeFormat.html for details
    
    Returns:
    
    the parsed timestamp
  - compareTo
```
public int compareTo(Timestamp other)
```
    Specified by:
    
    compareTo in interface Comparable<Timestamp>
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getInstant
```
public Instant getInstant()
```
    Return an Instant that corresponds to the point on the time-line represented by this Timestamp.
    
    Returns:
    
    the corresponding Instant
  - getJoda
```
public DateTime getJoda()
```
    Return the Joda DateTime object that corresponds to this Timestamp.
    
    Returns:
    
    the corresponding joda DateTime
  - getMicros
```
public long getMicros()
```
    Return the number of microseconds since the Unix epoch that is represented by this Timestamp.
    
    Returns:
    
    the microseconds
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isDateOnly
```
public boolean isDateOnly()
```
    Return true of this Timestamp does not have relevant temporal componet.
    
    Returns:
    
    true if this Timestamp represents a date
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Timestamp

Field Summary

Method Summary

Methods inherited from class Object

Field Detail

DEFAULT_DATE_ONLY_FORMATTER

DEFAULT_FORMATTER

Method Detail

epoch

fromInstant

fromJoda

fromMicros

fromString

now

now

now

parse

parse

compareTo

equals

getInstant

getJoda

getMicros

hashCode

isDateOnly

toString