com.atlassian.bitbucket.util

Interface DateFormatter

public interface DateFormatter

Allows the formatting of a date according to predefined formats.

See Also:

DateFormatter.FormatType

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DateFormatter.FormatType A predefined date format.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_KEY_PREFIX

Method Summary

Modifier and Type	Method and Description
String	formatDate(Date date, DateFormatter.FormatType type) Format the passed date.
String	formatInstant(Instant instant, DateFormatter.FormatType type) Format the passed Instant.
String	getFormatString(String key)

Field Detail

PROPERTY_KEY_PREFIX

static final String PROPERTY_KEY_PREFIX

See Also:

Constant Field Values

Method Detail

formatDate

@Nonnull
String formatDate(@Nonnull
                           Date date,
                           @Nonnull
                           DateFormatter.FormatType type)

Format the passed date.

Parameters:

date - the date to format.

type - the type of date rendering to generate.

Returns:

the formatted date.

formatInstant

@Nonnull
String formatInstant(@Nonnull
                              Instant instant,
                              @Nonnull
                              DateFormatter.FormatType type)

Format the passed Instant.

Parameters:

instant - the instant to render.

type - the type of date rendering to generate.

Returns:

the formatted instant.

Throws:

NullPointerException - if any of the arguments is null.

Since:

4.5

getFormatString

@Nullable
String getFormatString(@Nullable
                                 String key)