org.marketcetera.util.ws.wrappers
Class DateWrapper

java.lang.Object
  org.marketcetera.util.ws.wrappers.BaseWrapper<R>
      org.marketcetera.util.ws.wrappers.DualWrapper<Date,Long>
          org.marketcetera.util.ws.wrappers.DateWrapper

All Implemented Interfaces:

Externalizable, Serializable, Comparable<DateWrapper>

public class DateWrapper
extends DualWrapper<Date,Long>
implements Comparable<DateWrapper>

A dual-form wrapper for marshalling a date. The raw form is Date, and the marshalled form is Long. A wrapper is necessary because date objects are not marshalled correctly under certain time zones, including GMT.

Since:

1.5.0

Version:

$Id: DateWrapper.java 16154 2012-07-14 16:34:05Z colin $

Author:

tlerios@marketcetera.com

See Also:

Serialized Form

Constructor Summary

DateWrapper()
Creates a new wrapper.

DateWrapper(Date date)
Creates a new wrapper for the given date.

Method Summary

int	compareTo(DateWrapper other)
protected void	toMarshalled() Sets the marshalled form of the receiver's value so that it corresponds to its raw form.
protected void	toRaw() Sets the raw form of the receiver's value so that it corresponds to its marshalled form.

Methods inherited from class org.marketcetera.util.ws.wrappers.DualWrapper

getMarshalled, getRaw, readExternal, setMarshalled, setMarshalledOnly, setRaw, setRawOnly, writeExternal

Methods inherited from class org.marketcetera.util.ws.wrappers.BaseWrapper

equals, getValue, hashCode, setValue, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DateWrapper

public DateWrapper(Date date)

Creates a new wrapper for the given date.

Parameters:

date - The date, which may be null.

DateWrapper

public DateWrapper()

Creates a new wrapper. This empty constructor is intended for use by JAXB and Java serialization.

Method Detail

toRaw

protected void toRaw()

Description copied from class: DualWrapper

Sets the raw form of the receiver's value so that it corresponds to its marshalled form. The subclass implementation can assume that the latter form is non-null. The subclass may modify both the former and latter forms (for example, if the latter form is invalid). Only DualWrapper.setRawOnly(Object) and DualWrapper.setMarshalledOnly(Object) should be used in setting either form, to prevent infinite recursion. The raw form is null if and only if the marshalled one is null; the caller of this method will enforce this invariant, so the subclass implementation can set just the raw form to null.

Specified by:

toRaw in class DualWrapper<Date,Long>

toMarshalled

protected void toMarshalled()

Description copied from class: DualWrapper

Sets the marshalled form of the receiver's value so that it corresponds to its raw form. The subclass implementation can assume that the latter form is non-null. The subclass may modify both the former and latter forms (for example, if the latter form is invalid). Only DualWrapper.setRawOnly(Object) and DualWrapper.setMarshalledOnly(Object) should be used in setting either form, to prevent infinite recursion. The raw form is null if and only if the marshalled one is null; the caller of this method will enforce this invariant, so the subclass implementation can set just the marshalled form to null.

Specified by:

toMarshalled in class DualWrapper<Date,Long>

compareTo

public int compareTo(DateWrapper other)

Specified by:

compareTo in interface Comparable<DateWrapper>