com.box.androidsdk.content.utils

Class BoxDateFormat

java.lang.Object

com.box.androidsdk.content.utils.BoxDateFormat

public final class BoxDateFormat
extends java.lang.Object

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

Method Summary

Modifier and Type	Method and Description
static java.util.Date	convertToDay(java.util.Date date)
static java.lang.String	format(java.util.Date date) Formats a date as a string that can be sent to the Box API.
static java.lang.String	formatRoundToDay(java.util.Date date) Formats a date as a string that can be sent to the Box API.
static java.util.Date[]	getTimeRangeDates(java.lang.String timeRangeString) Get back a from date and to date given a timeRangeString created from BoxDateForm.getTimeRangeString().
static java.lang.String	getTimeRangeString(java.util.Date fromDate, java.util.Date toDate) Get a String to represent a time range.
static java.util.Date	parse(java.lang.String dateString) Parses a date string returned by the Box API into a Date object.
static java.util.Date	parseHeaderDate(java.lang.String dateString) Parses a date string returned by the Box API inside headers into a Date object.
static java.util.Date	parseRoundToDay(java.lang.String dateString) Parses a date string returned by the Box API into a Date object.

Methods inherited from class java.lang.Object

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

Method Detail

parse

public static java.util.Date parse(java.lang.String dateString)
                            throws java.text.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:

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

format

public static java.lang.String format(java.util.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.

parseRoundToDay

public static java.util.Date parseRoundToDay(java.lang.String dateString)
                                      throws java.text.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:

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

formatRoundToDay

public static java.lang.String formatRoundToDay(java.util.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.

parseHeaderDate

public static java.util.Date parseHeaderDate(java.lang.String dateString)
                                      throws java.text.ParseException

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

Parameters:

dateString - a string containing the date.

Returns:

the parsed date.

Throws:

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

getTimeRangeString

public static java.lang.String getTimeRangeString(java.util.Date fromDate,
                                                  java.util.Date toDate)

Get a String to represent a time range.

Parameters:

fromDate - can use null if don't want to specify this.

toDate - can use null if don't want to specify this.

Returns:

The string will be time strings separated by a comma. Trailing "from_date," and leading ",to_date" are also accepted if one of the date is null. Returns null if both dates are null.

getTimeRangeDates

public static java.util.Date[] getTimeRangeDates(java.lang.String timeRangeString)

Get back a from date and to date given a timeRangeString created from BoxDateForm.getTimeRangeString().

Parameters:

timeRangeString - a timeRangeString created from BoxDateForm.getTimeRangeString()

Returns:

an array of the from date and to date with Date[0] being from and Date[1] being to. Values can potentially be null.

convertToDay

public static java.util.Date convertToDay(java.util.Date date)
                                   throws java.text.ParseException

Throws:

java.text.ParseException