STAbstractInstant (Plugin basics for external printing 1.33 API)

java.lang.Object
- com.secutix.plugin.externalprinting.v1_0.catalog.dto.STAbstractInstant<T>

Type Parameters:

T - Actual instant type.

All Implemented Interfaces:

Serializable, Comparable<T>

Direct Known Subclasses:

STAbstractDate
```
public abstract class STAbstractInstant<T extends STAbstractInstant<T>>
extends Object
implements Comparable<T>, Serializable
```
Abstract class for a part of a date/time value (an instant of time) in Gregorian Calendar. A part of a full date can be: date, time or a combination of date and time.

Author:

lnt

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Date`	`dateTime` A `Date` object used inside this instant.
`static String`	`FORMAT_PATTERN_DATE_ISO` Date format ISO pattern.
`static String`	`FORMAT_PATTERN_DATETIME_ISO` Date/time format ISO pattern.
`static String`	`FORMAT_PATTERN_TIME_ISO` Time format ISO pattern.

Constructor Summary

Constructors
Constructor and Description

STAbstractInstant()

Constructors
Constructor and Description
`STAbstractInstant()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract T`	`clone()` TODO : REMOVE, cf http://www.javapractices.com/topic/TopicAction.do?Id=71
`int`	`compareTo(T o)` Compares 2 instant objects.
`protected Calendar`	`createCalendar()` Creates a new `GregorianCalendar` instance and set current date time (`dateTime`) to this calendar.
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`boolean`	`isAfter(T o)` Checks if current instant is after given instant.
`boolean`	`isAfterOrEqual(T o)` Checks if current instant is after given instant.
`boolean`	`isBefore(T o)` Checks if current instant is before given instant.
`boolean`	`isBeforeOrEqual(T o)` Checks if current instant is before or equal given instant.
`boolean`	`isBetween(T start, T end)` Checks if current instant is between 2 given instants.
`abstract boolean`	`isSet()` Checks if current instant is set.
`static boolean`	`isSet(STAbstractInstant<?> instant)` Checks if a given instant is set.
`protected T`	`rawAdd(int field, int value)` Safely adds a value into a given field in source calendar.
`protected T`	`rawSubstract(int field, int value)` Safely substracts a value from a given field in source calendar.
`protected void`	`reset()` Resets all fields of this instant.
`protected void`	`setDateFields(int year, int month, int dayOfMonth)` Sets all date fields.
`protected void`	`setTimeFields(int hour, int minute, int second)` Sets all time fields.
`String`	`toIsoDateTimeString()`
`String`	`toString()` Returns string presentation of this instant in ISO date/time format with default locale (See `Locale.getDefault()`).
`String`	`toString(String pattern)` Returns string presentation of this instant in given format pattern with default locale (See `Locale.getDefault()`).
`String`	`toString(String pattern, Locale locale)` Returns string presentation of this instant in given format pattern with given locale instance.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - FORMAT_PATTERN_DATE_ISO
```
public static final String FORMAT_PATTERN_DATE_ISO
```
    Date format ISO pattern.
    
    See Also:
    
    Constant Field Values
  - FORMAT_PATTERN_TIME_ISO
```
public static final String FORMAT_PATTERN_TIME_ISO
```
    Time format ISO pattern.
    
    See Also:
    
    Constant Field Values
  - FORMAT_PATTERN_DATETIME_ISO
```
public static final String FORMAT_PATTERN_DATETIME_ISO
```
    Date/time format ISO pattern.
    
    See Also:
    
    Constant Field Values
  - dateTime
```
protected Date dateTime
```
    A Date object used inside this instant.
- Constructor Detail
  - STAbstractInstant
```
public STAbstractInstant()
```
- Method Detail
  - isSet
```
public static boolean isSet(STAbstractInstant<?> instant)
```
    Checks if a given instant is set.
    
    Parameters:
    
    instant - Instant to be checked. null is considered unset.
    
    Returns:
    
    true if given instant is set.
  - isSet
```
public abstract boolean isSet()
```
    Checks if current instant is set. The meaning of 'is set' depends on the implementation of its subclasses.
    
    Returns:
    
    true if this instant is set.
  - toString
```
public String toString(String pattern,
                       Locale locale)
```
    Returns string presentation of this instant in given format pattern with given locale instance.
    
    Parameters:
    
    pattern - Pattern to format instant value. If no pattern is specified (that is, null or empty string), ISO date/time format pattern will be used.
    
    locale - Locale that provides language setting for result presentation. If no locale is specified, the default locale will be used (See Locale.getDefault()).
    
    Returns:
    
    String presentation of current instant.
    
    See Also:
    
    Locale.getDefault()
  - toString
```
public String toString()
```
    Returns string presentation of this instant in ISO date/time format with default locale (See Locale.getDefault()).
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String presentation of current instant.
  - toString
```
public String toString(String pattern)
```
    Returns string presentation of this instant in given format pattern with default locale (See Locale.getDefault()).
    
    Parameters:
    
    pattern - Pattern to format instant value. If no pattern is specified (that is, null or empty string), ISO date/time format pattern will be used.
    
    Returns:
    
    String presentation of current instant.
  - toIsoDateTimeString
```
public String toIsoDateTimeString()
```
  - compareTo
```
public int compareTo(T o)
```
    Compares 2 instant objects.
    Remarks: null values are always before not-null values. And unset instants are compared using the same method that has been applied to null.
    Specified by:
    
    compareTo in interface Comparable<T extends STAbstractInstant<T>>
    
    Parameters:
    
    o - An instant object comparing with this object.
    
    Returns:
    There are 3 cases:
    
    0: If 2 instant objects are null, are unset, or have the same.
    1: If given instant object is null, is unset while this instant is set, or before this instant.
    -1: Other cases.
  - isBefore
```
public boolean isBefore(T o)
```
    Checks if current instant is before given instant.
    
    Parameters:
    
    o - Given instant.
    
    Returns:
    
    true if current instant is before given instant. Otherwise, return false.
  - isBeforeOrEqual
```
public boolean isBeforeOrEqual(T o)
```
    Checks if current instant is before or equal given instant.
    
    Parameters:
    
    o - Given instant.
    
    Returns:
    
    true if current instant is before or equal given instant. Otherwise, return false.
  - isAfter
```
public boolean isAfter(T o)
```
    Checks if current instant is after given instant.
    
    Parameters:
    
    o - Given instant.
    
    Returns:
    
    true if current instant is after given instant. Otherwise, return false.
  - isAfterOrEqual
```
public boolean isAfterOrEqual(T o)
```
    Checks if current instant is after given instant.
    
    Parameters:
    
    o - Given instant.
    
    Returns:
    
    true if current instant is after or equal given instant. Otherwise, return false.
  - isBetween
```
public boolean isBetween(T start,
                         T end)
```
    Checks if current instant is between 2 given instants.
    
    Parameters:
    
    start - Lower bound instant. Required.
    
    end - Upper bound instant. Required.
    
    Returns:
    
    true if current instant is finity and in [start, end].
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - reset
```
protected void reset()
```
    Resets all fields of this instant.
  - clone
```
protected abstract T clone()
```
    TODO : REMOVE, cf http://www.javapractices.com/topic/TopicAction.do?Id=71
    
    Overrides:
    
    clone in class Object
  - createCalendar
```
protected Calendar createCalendar()
```
    Creates a new GregorianCalendar instance and set current date time (dateTime) to this calendar.
    
    Returns:
    
    New calendar instance.
  - rawAdd
```
protected T rawAdd(int field,
                   int value)
```
    Safely adds a value into a given field in source calendar.
    
    Parameters:
    
    field - Calendar field. See Calendar documentation for a list of valid fields.
    
    value - Adding value. Only positive number or zero is allowed.
    
    Returns:
    
    current instance.
    
    Throws:
    
    ArithmeticException - if given value is negative.
  - rawSubstract
```
protected T rawSubstract(int field,
                         int value)
```
    Safely substracts a value from a given field in source calendar.
    
    Parameters:
    
    field - Calendar field. See Calendar documentation for a list of valid fields.
    
    value - Substracting value. Only positive number or zero is allowed.
    
    Returns:
    
    current instance.
    
    Throws:
    
    ArithmeticException - if given value is negative.
  - setDateFields
```
protected void setDateFields(int year,
                             int month,
                             int dayOfMonth)
```
    Sets all date fields. All date fields are validated before set.
    
    Parameters:
    
    year - Year value, 4-digit number.
    
    month - Month value, from 1 to 12.
    
    dayOfMonth - Day of month, from 1 to maximum 31.
  - setTimeFields
```
protected void setTimeFields(int hour,
                             int minute,
                             int second)
```
    Sets all time fields. All time fields are validated before set.
    
    Parameters:
    
    hour - Hour of day (0 to 23).
    
    minute - Minute of hour (0 to 59).
    
    second - Second of minute (0 to 59).
    
    millisec - Millisecond (0 to 999).

Class STAbstractInstant<T extends STAbstractInstant<T>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FORMAT_PATTERN_DATE_ISO

FORMAT_PATTERN_TIME_ISO

FORMAT_PATTERN_DATETIME_ISO

dateTime

Constructor Detail

STAbstractInstant

Method Detail

isSet

isSet

toString

toString

toString

toIsoDateTimeString

compareTo

isBefore

isBeforeOrEqual

isAfter

isAfterOrEqual

isBetween

equals

hashCode

reset

clone

createCalendar

rawAdd

rawSubstract

setDateFields

setTimeFields