com.inductiveautomation.rm.base

Class RMDateFormat

java.lang.Object

java.text.Format

java.text.DateFormat

java.text.SimpleDateFormat

com.inductiveautomation.rm.base.RMDateFormat

All Implemented Interfaces:

Archivable, RMFormat, java.io.Serializable, java.lang.Cloneable

public class RMDateFormat
extends java.text.SimpleDateFormat
implements RMFormat

This is just a SimpleDateFormat subclass to support RM archiving and legacy formats.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.text.DateFormat

java.text.DateFormat.Field

Field Summary

Fields

Modifier and Type	Field and Description
static RMDateFormat	DEFAULT
static RMDateFormat	defaultFormat

Fields inherited from class java.text.DateFormat

AM_PM_FIELD, calendar, DATE_FIELD, DAY_OF_WEEK_FIELD, DAY_OF_WEEK_IN_MONTH_FIELD, DAY_OF_YEAR_FIELD, ERA_FIELD, FULL, HOUR_OF_DAY0_FIELD, HOUR_OF_DAY1_FIELD, HOUR0_FIELD, HOUR1_FIELD, LONG, MEDIUM, MILLISECOND_FIELD, MINUTE_FIELD, MONTH_FIELD, numberFormat, SECOND_FIELD, SHORT, TIMEZONE_FIELD, WEEK_OF_MONTH_FIELD, WEEK_OF_YEAR_FIELD, YEAR_FIELD

Constructor Summary

Constructors

Constructor and Description
RMDateFormat() Creates a plain format.
RMDateFormat(java.lang.String aFormat) Creates a format from the given string format.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object anObj) Standard equals implementation.
java.lang.Object	formatRM(java.lang.Object obj) Formats the given object.
java.lang.Object	fromXML(RXArchiver anArchiver, RXElement anElement) XML unarchival.
java.lang.String	getFormatString() Returns the date format string.
java.lang.String	getNullString() Returns the String that is substituted when this format is asked to provide stringForObjectValue(null).
void	setFormatString(java.lang.String aFormat) Sets the date format string.
void	setNullString(java.lang.String aString) Sets the String that is substituted when this format is asked to provide stringForObjectValue(null).
java.lang.String	toString() Returns string representation of this format.
RXElement	toXML(RXArchiver anArchiver) XML archival.

Methods inherited from class java.text.SimpleDateFormat

applyLocalizedPattern, applyPattern, clone, format, formatToCharacterIterator, get2DigitYearStart, getDateFormatSymbols, hashCode, parse, set2DigitYearStart, setDateFormatSymbols, toLocalizedPattern, toPattern

Methods inherited from class java.text.DateFormat

format, format, getAvailableLocales, getCalendar, getDateInstance, getDateInstance, getDateInstance, getDateTimeInstance, getDateTimeInstance, getDateTimeInstance, getInstance, getNumberFormat, getTimeInstance, getTimeInstance, getTimeInstance, getTimeZone, isLenient, parse, parseObject, setCalendar, setLenient, setNumberFormat, setTimeZone

Methods inherited from class java.text.Format

format, parseObject

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static RMDateFormat DEFAULT

defaultFormat

public static RMDateFormat defaultFormat

Constructor Detail

RMDateFormat

public RMDateFormat()

Creates a plain format.

RMDateFormat

public RMDateFormat(java.lang.String aFormat)

Creates a format from the given string format.

Method Detail

getNullString

public java.lang.String getNullString()

Returns the String that is substituted when this format is asked to provide stringForObjectValue(null).

setNullString

public void setNullString(java.lang.String aString)

Sets the String that is substituted when this format is asked to provide stringForObjectValue(null).

getFormatString

public java.lang.String getFormatString()

Returns the date format string.

Specified by:

getFormatString in interface RMFormat

setFormatString

public void setFormatString(@Nonnull
                            java.lang.String aFormat)

Sets the date format string. Has support for legacy RM formats and Java style.

Specified by:

setFormatString in interface RMFormat

formatRM

public java.lang.Object formatRM(java.lang.Object obj)

Formats the given object.

Specified by:

formatRM in interface RMFormat

equals

public boolean equals(java.lang.Object anObj)

Standard equals implementation.

Overrides:

equals in class java.text.SimpleDateFormat

toXML

public RXElement toXML(RXArchiver anArchiver)

XML archival.

Specified by:

toXML in interface Archivable

fromXML

public java.lang.Object fromXML(RXArchiver anArchiver,
                                RXElement anElement)

XML unarchival.

Specified by:

fromXML in interface Archivable

toString

public java.lang.String toString()

Returns string representation of this format.

Overrides:

toString in class java.lang.Object