org.sonar.api.utils

Class DateUtils

java.lang.Object

org.sonar.api.utils.DateUtils

public final class DateUtils
extends Object

Parses and formats RFC 822 dates. This class is thread-safe.

Since:

2.7

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATE_FORMAT
static String	DATETIME_FORMAT

Method Summary

Modifier and Type	Method and Description
static Date	addDays(Date date, int numberOfDays) Adds a number of days to a date returning a new object.
static Long	dateToLong(Date date)
static String	formatDate(Date d) Warning: relies on default timezone!
static String	formatDateTime(Date d) Warning: relies on default timezone!
static String	formatDateTime(long ms) Warning: relies on default timezone!
static String	formatDateTime(OffsetDateTime dt)
static String	formatDateTimeNullSafe(Date date) Warning: relies on default timezone!
static Date	longToDate(Long time)
static Date	parseDate(String s) Return a date at the start of day.
static Date	parseDateOrDateTime(String stringDate) Warning: may rely on default timezone!
static Date	parseDateQuietly(String s) Parse format DATE_FORMAT.
static Date	parseDateTime(String s)
static Date	parseDateTimeQuietly(String s) Parse format DATETIME_FORMAT.
static Date	parseEndingDateOrDateTime(String stringDate) Return the datetime if @param stringDate is a datetime, date + 1 day if stringDate is a date.
static LocalDate	parseLocalDate(String s)
static LocalDate	parseLocalDateQuietly(String s) Parse format DATE_FORMAT.
static OffsetDateTime	parseOffsetDateTime(String s)
static OffsetDateTime	parseOffsetDateTimeQuietly(String s) Parse format DATETIME_FORMAT.
static Date	parseStartingDateOrDateTime(String stringDate) Warning: may rely on default timezone!
static Date	truncateToSeconds(Date d)
static long	truncateToSeconds(long dateTime)

Methods inherited from class java.lang.Object

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

Field Detail

DATE_FORMAT

public static final String DATE_FORMAT

See Also:

Constant Field Values

DATETIME_FORMAT

public static final String DATETIME_FORMAT

See Also:

Constant Field Values

Method Detail

formatDate

public static String formatDate(Date d)

Warning: relies on default timezone!

formatDateTime

public static String formatDateTime(Date d)

Warning: relies on default timezone!

formatDateTime

public static String formatDateTime(long ms)

Warning: relies on default timezone!

formatDateTime

public static String formatDateTime(OffsetDateTime dt)

Since:

6.6

formatDateTimeNullSafe

public static String formatDateTimeNullSafe(@Nullable
                                            Date date)

Warning: relies on default timezone!

longToDate

@CheckForNull
public static Date longToDate(@Nullable
                                            Long time)

dateToLong

@CheckForNull
public static Long dateToLong(@Nullable
                                            Date date)

parseDate

public static Date parseDate(String s)

Return a date at the start of day.

Parameters:

s - string in format DATE_FORMAT

Throws:

SonarException - when string cannot be parsed

parseDateQuietly

@CheckForNull
public static Date parseDateQuietly(@Nullable
                                                  String s)

Parse format DATE_FORMAT. This method never throws exception.

Parameters:

s - any string

Returns:

the date, null if parsing error or if parameter is null

Since:

3.0

parseLocalDate

public static LocalDate parseLocalDate(String s)

Since:

6.6

parseLocalDateQuietly

@CheckForNull
public static LocalDate parseLocalDateQuietly(@Nullable
                                                            String s)

Parse format DATE_FORMAT. This method never throws exception.

Parameters:

s - any string

Returns:

the date, null if parsing error or if parameter is null

Since:

6.6

parseDateTime

public static Date parseDateTime(String s)

Parameters:

s - string in format DATETIME_FORMAT

Throws:

SonarException - when string cannot be parsed

parseOffsetDateTime

public static OffsetDateTime parseOffsetDateTime(String s)

Parameters:

s - string in format DATETIME_FORMAT

Throws:

SonarException - when string cannot be parsed

Since:

6.6

parseDateTimeQuietly

@CheckForNull
public static Date parseDateTimeQuietly(@Nullable
                                                      String s)

Parse format DATETIME_FORMAT. This method never throws exception.

Parameters:

s - any string

Returns:

the datetime, null if parsing error or if parameter is null

parseOffsetDateTimeQuietly

@CheckForNull
public static OffsetDateTime parseOffsetDateTimeQuietly(@Nullable
                                                                      String s)

Parse format DATETIME_FORMAT. This method never throws exception.

Parameters:

s - any string

Returns:

the datetime, null if parsing error or if parameter is null

Since:

6.6

parseDateOrDateTime

@CheckForNull
public static Date parseDateOrDateTime(@Nullable
                                                     String stringDate)

Warning: may rely on default timezone!

Returns:

the datetime, null if stringDate is null

Throws:

IllegalArgumentException - if stringDate is not a correctly formed date or datetime

Since:

6.1

parseStartingDateOrDateTime

@CheckForNull
public static Date parseStartingDateOrDateTime(@Nullable
                                                             String stringDate)

Warning: may rely on default timezone!

See Also:

parseDateOrDateTime(String)

parseEndingDateOrDateTime

@CheckForNull
public static Date parseEndingDateOrDateTime(@Nullable
                                                           String stringDate)

Return the datetime if @param stringDate is a datetime, date + 1 day if stringDate is a date. So '2016-09-01' would return a date equivalent to '2016-09-02T00:00:00+0000' in GMT (Warning: relies on default timezone!)

Returns:

the datetime, null if stringDate is null

Throws:

IllegalArgumentException - if stringDate is not a correctly formed date or datetime

Since:

6.1

See Also:

parseDateOrDateTime(String)

addDays

public static Date addDays(Date date,
                           int numberOfDays)

Adds a number of days to a date returning a new object. The original date object is unchanged.

Parameters:

date - the date, not null

numberOfDays - the amount to add, may be negative

Returns:

the new date object with the amount added

truncateToSeconds

@CheckForNull
public static Date truncateToSeconds(@Nullable
                                                   Date d)

truncateToSeconds

public static long truncateToSeconds(long dateTime)