com.box.sdk

Class BoxDateFormat

Object

BoxDateFormat

public final class BoxDateFormat
extends Object

Contains methods for parsing and formatting dates for use with the Box API.

Method Summary

Modifier and Type	Method and Description
static String	format(Date date) Formats a date as a string that can be sent to the Box API.
static String	format(Instant instant) Formats an Instant as a string that can be sent to the Box API.
static String	formatAsDateOnly(Date date) Formats a date as a string yyyy-MM-dd that can be sent to the Box API.
static Date	parse(String dateString) Parses a date string returned by the Box API into a Date object.
static Date	parseDateOnly(String date) Parses a date in format of yyyy-MM-dd.

Methods inherited from class Object

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

Method Detail

parse

public static Date parse(String dateString)
                  throws ParseException

Parses a date string returned by the Box API into a Date object.

Parameters:

dateString - a string containing the date.

Returns:

the parsed date.

Throws:

ParseException - if the string cannot be parsed into a valid date.

parseDateOnly

public static Date parseDateOnly(String date)
                          throws ParseException

Parses a date in format of yyyy-MM-dd.

Parameters:

date - date to parse.

Returns:

parsed date.

Throws:

ParseException - if the string cannot be parsed into a valid date.

format

public static String format(Date date)

Formats a date as a string that can be sent to the Box API.

Parameters:

date - the date to format.

Returns:

a string containing the formatted date.

format

public static String format(Instant instant)

Formats an Instant as a string that can be sent to the Box API.

Parameters:

instant - the instant to format.

Returns:

a string containing the formatted instant.

formatAsDateOnly

public static String formatAsDateOnly(Date date)

Formats a date as a string yyyy-MM-dd that can be sent to the Box API.

Parameters:

date - the date to format.

Returns:

a yyyy-MM-dd string containing the formatted date.