com.caplin.motif.fx.trading.orders.submission

Class OrderValidityDate

java.lang.Object

com.caplin.motif.fx.trading.orders.submission.OrderValidityDate

Direct Known Subclasses:

ActivationDate, ExpirationDate

public class OrderValidityDate
extends Object

Parent class of ActivationDate and ExpirationDate that represents a date for an order.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Pattern	DATE_PATTERN
protected String	dateStr
protected Date	datetime
protected boolean	isLocal
static String	LOCAL
protected String	location
protected String	offset
protected String	timeStr
static String	ZEROED_OFFSET

Constructor Summary

Constructors

Constructor and Description
OrderValidityDate()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDateAsString() Gets the date as a string in the format "YYYYMMDD".
Date	getDateTime() Deprecated. The Date object returned by this method is created by parsing the date and time passed in to the parse(String, String, String, String) method, without taking the offset or location parameters into account. Because of this limitation, the Date object returned by this method is not a true representation of this instance of OrderValidityDate, and this method has been deprecated accordingly. Client code should use the methods getDateAsString(), getTimeAsString(), getLocation() and getOffset() instead.
String	getLocation() Gets the location that the date and time relate to.
String	getOffset() Gets the UTC offset for the time, in the format "[+-][0-9]{2}:[0-9]{2}", e.g "+01:00".
String	getTimeAsString() Gets the time as a string in the format "HH:MM:SS".
int	hashCode()
boolean	isLocal() Returns a boolean indicating whether this date and time were specified as local to the user, in which case a UTC offset should also be present and can be retrieved by calling getOffset(), or if the date and time relate to a specific location in which case no offset needs to be provided.
protected void	parse(String dateStr, String timeStr, String location, String offset) Sets the date, time, location and offset values from the parameters.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LOCAL

public static final String LOCAL

See Also:

Constant Field Values

ZEROED_OFFSET

public static final String ZEROED_OFFSET

See Also:

Constant Field Values

DATE_PATTERN

protected static final Pattern DATE_PATTERN

dateStr

protected String dateStr

timeStr

protected String timeStr

location

protected String location

offset

protected String offset

datetime

protected Date datetime

isLocal

protected boolean isLocal

Constructor Detail

OrderValidityDate

public OrderValidityDate()

Method Detail

parse

protected void parse(String dateStr,
                     String timeStr,
                     String location,
                     String offset)
              throws OrderConfigurationException

Sets the date, time, location and offset values from the parameters.

Parameters:

dateStr - A date in the format "YYYYMMDD".

timeStr - A time in the format "HH:MM:SS".

location - A location, which can be a place such as "London" or the string "LOCAL". If a location is provided, it is not necessary (or permitted) to provide an offset because it can be inferred from the date, time and location.

offset - A timezone offset in the format "[+-][0-9]{2}:[0-9]{2}", e.g "+01:00".

Throws:

OrderConfigurationException -

If:

• Any of dateStr, timeStr or location are null or empty.
• The location has the value LOCAL but the offset is null or empty.
• The location has the value LOCAL and the offset is specified in the wrong format.
• The location was provided (i.e not LOCAL) but an offset was also provided.
• The value of dateStr or timeStr are in the wrong format.

getDateTime

@Deprecated
public Date getDateTime()

Deprecated. The Date object returned by this method is created by parsing the date and time passed in to the parse(String, String, String, String) method, without taking the offset or location parameters into account. Because of this limitation, the Date object returned by this method is not a true representation of this instance of OrderValidityDate, and this method has been deprecated accordingly. Client code should use the methods getDateAsString(), getTimeAsString(), getLocation() and getOffset() instead.

Gets the date and time as an instance of Date.

Returns:

A Date object representing the date and time of this instance of OrderValidityDate, without taking the location or offset into account.

getDateAsString

public String getDateAsString()

Gets the date as a string in the format "YYYYMMDD".

Returns:

The date as a string.

getTimeAsString

public String getTimeAsString()

Gets the time as a string in the format "HH:MM:SS".

Returns:

The time as a string.

getLocation

public String getLocation()

Gets the location that the date and time relate to.

Returns:

The location if specified, otherwise null.

getOffset

public String getOffset()

Gets the UTC offset for the time, in the format "[+-][0-9]{2}:[0-9]{2}", e.g "+01:00".

Returns:

The timezone offset if specified, otherwise "00:00". The offset is only specified if this instance of OrderValidityDate was constructed with the location LOCAL.

isLocal

public boolean isLocal()

Returns a boolean indicating whether this date and time were specified as local to the user, in which case a UTC offset should also be present and can be retrieved by calling getOffset(), or if the date and time relate to a specific location in which case no offset needs to be provided.

Returns:

True if this date relates to the user's local time, false if it relates to a specific location.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object