| java.lang.Object org.joda.time.DateTimeField org.joda.time.field.BaseDateTimeField org.joda.time.field.DecoratedDateTimeField org.joda.time.field.OffsetDateTimeField
OffsetDateTimeField | public class OffsetDateTimeField extends DecoratedDateTimeField (Code) | | Generic offset adjusting datetime field.
OffsetDateTimeField is thread-safe and immutable.
author: Brian S O'Neill since: 1.0 |
Method Summary | |
public long | add(long instant, int amount) Add the specified amount of offset units to the specified time
instant. | public long | add(long instant, long amount) Add the specified amount of offset units to the specified time
instant. | public long | addWrapField(long instant, int amount) Add to the offset component of the specified time instant,
wrapping around within that component if necessary.
Parameters: instant - the time instant in millis to update. Parameters: amount - the amount of units to add (can be negative). | public int | get(long instant) Get the amount of offset units from the specified time instant.
Parameters: instant - the time instant in millis to query. | public int | getLeapAmount(long instant) | public DurationField | getLeapDurationField() | public int | getMaximumValue() Get the maximum value for the field. | public int | getMinimumValue() Get the minimum value for the field. | public int | getOffset() Returns the offset added to the field values. | public boolean | isLeap(long instant) | public long | remainder(long instant) | public long | roundCeiling(long instant) | public long | roundFloor(long instant) | public long | roundHalfCeiling(long instant) | public long | roundHalfEven(long instant) | public long | roundHalfFloor(long instant) | public long | set(long instant, int value) Set the specified amount of offset units to the specified time instant.
Parameters: instant - the time instant in millis to update. Parameters: value - value of units to set. |
OffsetDateTimeField | public OffsetDateTimeField(DateTimeField field, int offset)(Code) | | Constructor.
Parameters: field - the field to wrap, like "year()". Parameters: offset - offset to add to field values throws: IllegalArgumentException - if offset is zero |
OffsetDateTimeField | public OffsetDateTimeField(DateTimeField field, DateTimeFieldType type, int offset)(Code) | | Constructor.
Parameters: field - the field to wrap, like "year()". Parameters: type - the field type this field actually uses Parameters: offset - offset to add to field values throws: IllegalArgumentException - if offset is zero |
OffsetDateTimeField | public OffsetDateTimeField(DateTimeField field, DateTimeFieldType type, int offset, int minValue, int maxValue)(Code) | | Constructor.
Parameters: field - the field to wrap, like "year()". Parameters: type - the field type this field actually uses Parameters: offset - offset to add to field values Parameters: minValue - minimum allowed value Parameters: maxValue - maximum allowed value throws: IllegalArgumentException - if offset is zero |
add | public long add(long instant, int amount)(Code) | | Add the specified amount of offset units to the specified time
instant. The amount added may be negative.
Parameters: instant - the time instant in millis to update. Parameters: amount - the amount of units to add (can be negative). the updated time instant. |
add | public long add(long instant, long amount)(Code) | | Add the specified amount of offset units to the specified time
instant. The amount added may be negative.
Parameters: instant - the time instant in millis to update. Parameters: amount - the amount of units to add (can be negative). the updated time instant. |
addWrapField | public long addWrapField(long instant, int amount)(Code) | | Add to the offset component of the specified time instant,
wrapping around within that component if necessary.
Parameters: instant - the time instant in millis to update. 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 offset units from the specified time instant.
Parameters: instant - the time instant in millis to query. the amount of units extracted from the input. |
getLeapAmount | public int getLeapAmount(long instant)(Code) | | |
getMaximumValue | public int getMaximumValue()(Code) | | Get the maximum value for the field.
the maximum value |
getMinimumValue | public int getMinimumValue()(Code) | | Get the minimum value for the field.
the minimum value |
getOffset | public int getOffset()(Code) | | Returns the offset added to the field values.
the offset |
isLeap | public boolean isLeap(long instant)(Code) | | |
remainder | public long remainder(long instant)(Code) | | |
roundCeiling | public long roundCeiling(long instant)(Code) | | |
roundFloor | public long roundFloor(long instant)(Code) | | |
roundHalfCeiling | public long roundHalfCeiling(long instant)(Code) | | |
roundHalfEven | public long roundHalfEven(long instant)(Code) | | |
roundHalfFloor | public long roundHalfFloor(long instant)(Code) | | |
set | public long set(long instant, int value)(Code) | | Set the specified amount of offset units to the specified time instant.
Parameters: instant - the time instant in millis to update. Parameters: value - value of units to set. the updated time instant. throws: IllegalArgumentException - if value is too large or too small. |
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)
|
Methods inherited from org.joda.time.DateTimeField | abstract public long add(long instant, int value)(Code)(Java Doc) abstract public long add(long instant, long value)(Code)(Java Doc) abstract public int[] add(ReadablePartial instant, int fieldIndex, int[] values, int valueToAdd)(Code)(Java Doc) abstract public long addWrapField(long instant, int value)(Code)(Java Doc) abstract public int[] addWrapField(ReadablePartial instant, int fieldIndex, int[] values, int valueToAdd)(Code)(Java Doc) abstract public int[] addWrapPartial(ReadablePartial instant, int fieldIndex, int[] values, int valueToAdd)(Code)(Java Doc) abstract public int get(long instant)(Code)(Java Doc) abstract public String getAsShortText(long instant, Locale locale)(Code)(Java Doc) abstract public String getAsShortText(long instant)(Code)(Java Doc) abstract public String getAsShortText(ReadablePartial partial, int fieldValue, Locale locale)(Code)(Java Doc) abstract public String getAsShortText(ReadablePartial partial, Locale locale)(Code)(Java Doc) abstract public String getAsShortText(int fieldValue, Locale locale)(Code)(Java Doc) abstract public String getAsText(long instant, Locale locale)(Code)(Java Doc) abstract public String getAsText(long instant)(Code)(Java Doc) abstract public String getAsText(ReadablePartial partial, int fieldValue, Locale locale)(Code)(Java Doc) abstract public String getAsText(ReadablePartial partial, Locale locale)(Code)(Java Doc) abstract public String getAsText(int fieldValue, Locale locale)(Code)(Java Doc) abstract public int getDifference(long minuendInstant, long subtrahendInstant)(Code)(Java Doc) abstract public long getDifferenceAsLong(long minuendInstant, long subtrahendInstant)(Code)(Java Doc) abstract public DurationField getDurationField()(Code)(Java Doc) abstract public int getLeapAmount(long instant)(Code)(Java Doc) abstract public DurationField getLeapDurationField()(Code)(Java Doc) abstract public int getMaximumShortTextLength(Locale locale)(Code)(Java Doc) abstract public int getMaximumTextLength(Locale locale)(Code)(Java Doc) abstract public int getMaximumValue()(Code)(Java Doc) abstract public int getMaximumValue(long instant)(Code)(Java Doc) abstract public int getMaximumValue(ReadablePartial instant)(Code)(Java Doc) abstract public int getMaximumValue(ReadablePartial instant, int[] values)(Code)(Java Doc) abstract public int getMinimumValue()(Code)(Java Doc) abstract public int getMinimumValue(long instant)(Code)(Java Doc) abstract public int getMinimumValue(ReadablePartial instant)(Code)(Java Doc) abstract public int getMinimumValue(ReadablePartial instant, int[] values)(Code)(Java Doc) abstract public String getName()(Code)(Java Doc) abstract public DurationField getRangeDurationField()(Code)(Java Doc) abstract public DateTimeFieldType getType()(Code)(Java Doc) abstract public boolean isLeap(long instant)(Code)(Java Doc) abstract public boolean isLenient()(Code)(Java Doc) abstract public boolean isSupported()(Code)(Java Doc) abstract public long remainder(long instant)(Code)(Java Doc) abstract public long roundCeiling(long instant)(Code)(Java Doc) abstract public long roundFloor(long instant)(Code)(Java Doc) abstract public long roundHalfCeiling(long instant)(Code)(Java Doc) abstract public long roundHalfEven(long instant)(Code)(Java Doc) abstract public long roundHalfFloor(long instant)(Code)(Java Doc) abstract public long set(long instant, int value)(Code)(Java Doc) abstract public int[] set(ReadablePartial instant, int fieldIndex, int[] values, int newValue)(Code)(Java Doc) abstract public long set(long instant, String text, Locale locale)(Code)(Java Doc) abstract public long set(long instant, String text)(Code)(Java Doc) abstract public int[] set(ReadablePartial instant, int fieldIndex, int[] values, String text, Locale locale)(Code)(Java Doc) abstract public String toString()(Code)(Java Doc)
|
|
|