| org.joda.time.field.BaseDateTimeField
 org.joda.time.field.PreciseDurationDateTimeField
org.joda.time.field.PreciseDateTimeField
| PreciseDateTimeField | | public class PreciseDateTimeField extends PreciseDurationDateTimeField (Code) | | Precise datetime field, composed of two precise duration fields.
This DateTimeField is useful for defining DateTimeFields that are composed
of precise durations, like time of day fields. If either duration field is
imprecise, then an
ImpreciseDateTimeField may be used instead.
PreciseDateTimeField is thread-safe and immutable.
author:
Brian S O'Neill
author:
Stephen Colebourne
since:
1.0
See Also: ImpreciseDateTimeField |
| Method Summary | |
| public long | addWrapField(long instant, int amount)
Add to the component of the specified time instant, wrapping around
within that component if necessary.
Parameters:
instant - the milliseconds from 1970-01-01T00:00:00Z to add to
Parameters:
amount - the amount of units to add (can be negative). | | public int | get(long instant)
Get the amount of fractional units from the specified time instant. | | public int | getMaximumValue()
Get the maximum value for the field. | | public int | getRange()
Returns the range of the field in the field's units.
For example, 60 for seconds per minute. | | public DurationField | getRangeDurationField()
Returns the range duration of this field. | | public long | set(long instant, int value)
Set the specified amount of units to the specified time instant.
Parameters:
instant - the milliseconds from 1970-01-01T00:00:00Z to set in
Parameters:
value - value of units to set. |
| PreciseDateTimeField | | public PreciseDateTimeField(DateTimeFieldType type, DurationField unit, DurationField range)(Code) | | Constructor.
Parameters:
type - the field type this field uses
Parameters:
unit - precise unit duration, like "seconds()".
Parameters:
range - precise range duration, preferably a multiple of the unit,like "minutes()".
throws:
IllegalArgumentException - if either duration field is imprecise
throws:
IllegalArgumentException - if unit milliseconds is less than oneor effective value range is less than two. |
| addWrapField | | public long addWrapField(long instant, int amount)(Code) | | Add to the component of the specified time instant, wrapping around
within that component if necessary.
Parameters:
instant - the milliseconds from 1970-01-01T00:00:00Z to add to
Parameters:
amount - the amount of units to add (can be negative). the updated time instant. |
| get | | public int get(long instant)(Code) | | Get the amount of fractional units from the specified time instant.
Parameters:
instant - the milliseconds from 1970-01-01T00:00:00Z to query the amount of fractional units extracted from the input. |
| getMaximumValue | | public int getMaximumValue()(Code) | | Get the maximum value for the field.
the maximum value |
| getRange | | public int getRange()(Code) | | Returns the range of the field in the field's units.
For example, 60 for seconds per minute. The field is allowed values
from 0 to range - 1.
unit range |
| getRangeDurationField | | public DurationField getRangeDurationField()(Code) | | Returns the range duration of this field. For example, if this field
represents "minute of hour", then the range duration field is an hours.
the range duration of this field, or null if field has no range |
| set | | public long set(long instant, int value)(Code) | | Set the specified amount of units to the specified time instant.
Parameters:
instant - the milliseconds from 1970-01-01T00:00:00Z to set in
Parameters:
value - value of units to set. the updated time instant.
throws:
IllegalArgumentException - if value is too large or too small. |
| Fields inherited from org.joda.time.field.PreciseDurationDateTimeField | final long iUnitMillis(Code)(Java Doc)
|
| Methods inherited from org.joda.time.field.BaseDateTimeField | public long add(long instant, int value)(Code)(Java Doc)
public long add(long instant, long value)(Code)(Java Doc)
public int[] add(ReadablePartial instant, int fieldIndex, int[] values, int valueToAdd)(Code)(Java Doc)
public long addWrapField(long instant, int value)(Code)(Java Doc)
public int[] addWrapField(ReadablePartial instant, int fieldIndex, int[] values, int valueToAdd)(Code)(Java Doc)
public int[] addWrapPartial(ReadablePartial instant, int fieldIndex, int[] values, int valueToAdd)(Code)(Java Doc)
protected int convertText(String text, Locale locale)(Code)(Java Doc)
abstract public int get(long instant)(Code)(Java Doc)
public String getAsShortText(long instant, Locale locale)(Code)(Java Doc)
final public String getAsShortText(long instant)(Code)(Java Doc)
public String getAsShortText(ReadablePartial partial, int fieldValue, Locale locale)(Code)(Java Doc)
final public String getAsShortText(ReadablePartial partial, Locale locale)(Code)(Java Doc)
public String getAsShortText(int fieldValue, Locale locale)(Code)(Java Doc)
public String getAsText(long instant, Locale locale)(Code)(Java Doc)
final public String getAsText(long instant)(Code)(Java Doc)
public String getAsText(ReadablePartial partial, int fieldValue, Locale locale)(Code)(Java Doc)
final public String getAsText(ReadablePartial partial, Locale locale)(Code)(Java Doc)
public String getAsText(int fieldValue, Locale locale)(Code)(Java Doc)
public int getDifference(long minuendInstant, long subtrahendInstant)(Code)(Java Doc)
public long getDifferenceAsLong(long minuendInstant, long subtrahendInstant)(Code)(Java Doc)
abstract public DurationField getDurationField()(Code)(Java Doc)
public int getLeapAmount(long instant)(Code)(Java Doc)
public DurationField getLeapDurationField()(Code)(Java Doc)
public int getMaximumShortTextLength(Locale locale)(Code)(Java Doc)
public int getMaximumTextLength(Locale locale)(Code)(Java Doc)
abstract public int getMaximumValue()(Code)(Java Doc)
public int getMaximumValue(long instant)(Code)(Java Doc)
public int getMaximumValue(ReadablePartial instant)(Code)(Java Doc)
public int getMaximumValue(ReadablePartial instant, int[] values)(Code)(Java Doc)
abstract public int getMinimumValue()(Code)(Java Doc)
public int getMinimumValue(long instant)(Code)(Java Doc)
public int getMinimumValue(ReadablePartial instant)(Code)(Java Doc)
public int getMinimumValue(ReadablePartial instant, int[] values)(Code)(Java Doc)
final public String getName()(Code)(Java Doc)
abstract public DurationField getRangeDurationField()(Code)(Java Doc)
final public DateTimeFieldType getType()(Code)(Java Doc)
public boolean isLeap(long instant)(Code)(Java Doc)
final public boolean isSupported()(Code)(Java Doc)
public long remainder(long instant)(Code)(Java Doc)
public long roundCeiling(long instant)(Code)(Java Doc)
abstract public long roundFloor(long instant)(Code)(Java Doc)
public long roundHalfCeiling(long instant)(Code)(Java Doc)
public long roundHalfEven(long instant)(Code)(Java Doc)
public long roundHalfFloor(long instant)(Code)(Java Doc)
abstract public long set(long instant, int value)(Code)(Java Doc)
public int[] set(ReadablePartial partial, int fieldIndex, int[] values, int newValue)(Code)(Java Doc)
public long set(long instant, String text, Locale locale)(Code)(Java Doc)
final public long set(long instant, String text)(Code)(Java Doc)
public int[] set(ReadablePartial instant, int fieldIndex, int[] values, String text, Locale locale)(Code)(Java Doc)
public String toString()(Code)(Java Doc)
|
|
|