|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.xins.common.types.Type org.xins.common.types.standard.Timestamp
Standard type _timestamp. A value of this type represents a certain moment in time, with second-precision, without an indication of the time zone.
The textual representation of a timestamp is always 14 numeric characters, in the format:
YYYYMMDDhhmmsswhere:
"2005"
.
"12"
for December.
"31"
for the last day of December.
"23"
for the last hour of the day.
"59"
for the last minute within the hour.
"59"
for the last second within the minute.
Note that all timestamps will be based on the current time zone (see
TimeZone.getDefault()
).
A number of milliseconds can be used to indicate a specific instant in time. This number of milliseconds is since the UNIX Epoch.
Nested Class Summary | |
static class |
Timestamp.Value
Value for the type _timestamp. |
Field Summary | |
static Timestamp |
SINGLETON
The only instance of this class. |
Method Summary | |
static Timestamp.Value |
fromStringForOptional(String string)
Constructs a Timestamp.Value from the specified string. |
static Timestamp.Value |
fromStringForRequired(String string)
Constructs a Timestamp.Value from the specified
non-null string. |
protected Object |
fromStringImpl(String string)
Converts from a String to an instance of the value class
for this type (implementation method). |
protected boolean |
isValidValueImpl(String value)
Determines if the specified String value is considered
valid for this type (implementation method). |
static Timestamp.Value |
now()
Constructs a Timestamp.Value with the value of the current
time. |
String |
toString(Object value)
Generates a string representation of the specified value for this type. |
static String |
toString(Timestamp.Value value)
Converts the specified Timestamp.Value to a string. |
Methods inherited from class org.xins.common.types.Type |
checkValue, fromString, getName, getValueClass, isValidValue, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final Timestamp SINGLETON
null
.
Method Detail |
public static Timestamp.Value now()
Timestamp.Value
with the value of the current
time.
Timestamp.Value
initialized with the current time,
never null
.public static Timestamp.Value fromStringForRequired(String string) throws IllegalArgumentException, TypeValueException
Timestamp.Value
from the specified
non-null
string.
string
- the string to convert, cannot be null
.
Timestamp.Value
object, never null
.
IllegalArgumentException
- if string == null
.
TypeValueException
- if the specified string does not represent a valid value for this
type.public static Timestamp.Value fromStringForOptional(String string) throws TypeValueException
Timestamp.Value
from the specified string.
string
- the string to convert, can be null
.
Timestamp.Value
, or null
if
string == null
.
TypeValueException
- if the specified string does not represent a valid value for this
type.public static String toString(Timestamp.Value value)
Timestamp.Value
to a string.
value
- the value to convert, can be null
.
null
if and only if value == null
.protected final boolean isValidValueImpl(String value)
Type
String
value is considered
valid for this type (implementation method).
This method is called from Type.isValidValue(String)
. When
called from that method, it is guaranteed that the argument is not
null
.
Type
returns
true
.
isValidValueImpl
in class Type
value
- the String
value that should be checked for validity,
never null
.
true
if and only if the specified String
value is valid, false
otherwise.protected final Object fromStringImpl(String string) throws TypeValueException
Type
String
to an instance of the value class
for this type (implementation method).
This method is not required to check the validity of the specified
value (since Type.isValidValueImpl(String)
should have been called
before) but if it does, then it may throw a TypeValueException
.
fromStringImpl
in class Type
string
- the string to convert to an instance of the value class, guaranteed
to be not null
and guaranteed to have been passed to
Type.isValidValueImpl(String)
without getting an exception.
null
.
TypeValueException
- if string
is considered to be an invalid value for this
type.public final String toString(Object value) throws IllegalArgumentException, ClassCastException, TypeValueException
Type
Type.getValueClass()
). Also, it may have to fall within a
certain range of valid values, depending on the type.
The default implementation of this method in class Type
does
the following:
value == null
then it throws an
IllegalArgumentException
;
getValueClass().isInstance(value) == false
then
it throws a ClassCastException
;
value.
Object.toString()
.
toString
in class Type
value
- the value, cannot be null
.
null
.
ClassCastException
- if getValueClass().isInstance(value) == false
.
IllegalArgumentException
- if value == null
.
TypeValueException
- if the specified value is not in the allowed range.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |