Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.joda.time.field
Class SkipUndoDateTimeField

java.lang.Object
  extended by org.joda.time.DateTimeField
      extended by org.joda.time.field.DelegatedDateTimeField
          extended by org.joda.time.field.SkipUndoDateTimeField
All Implemented Interfaces:
Serializable
public final class SkipUndoDateTimeField
extends DelegatedDateTimeField

Wraps another field such that a certain value is added back into the sequence of numbers.

This reverses the effect of SkipDateTimeField. This isn't very elegant.

SkipUndoDateTimeField is thread-safe and immutable.

Since:
1.0
See Also:
Serialized Form

Constructor Summary
SkipUndoDateTimeField(Chronology chronology, DateTimeField field)
          Constructor that reinserts zero.
SkipUndoDateTimeField(Chronology chronology, DateTimeField field, int skip)
          Constructor.
 
Method Summary
 int get(long millis)
          Get the value of this field from the milliseconds.
 int getMinimumValue()
          Get the minimum allowable value for this field.
 long set(long millis, int value)
          Sets a value in the milliseconds supplied.
 
Methods inherited from class org.joda.time.field.DelegatedDateTimeField
add, add, add, addWrapField, addWrapField, addWrapPartial, getAsShortText, getAsShortText, getAsShortText, getAsShortText, getAsShortText, getAsText, getAsText, getAsText, getAsText, getAsText, getDifference, getDifferenceAsLong, getDurationField, getLeapAmount, getLeapDurationField, getMaximumShortTextLength, getMaximumTextLength, getMaximumValue, getMaximumValue, getMaximumValue, getMaximumValue, getMinimumValue, getMinimumValue, getMinimumValue, getName, getRangeDurationField, getType, getWrappedField, isLeap, isLenient, isSupported, remainder, roundCeiling, roundFloor, roundHalfCeiling, roundHalfEven, roundHalfFloor, set, set, set, set, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SkipUndoDateTimeField

public SkipUndoDateTimeField(Chronology chronology,
                             DateTimeField field)
Constructor that reinserts zero.

Parameters:
chronology - the chronoogy to use
field - the field to skip zero on

SkipUndoDateTimeField

public SkipUndoDateTimeField(Chronology chronology,
                             DateTimeField field,
                             int skip)
Constructor.

Parameters:
chronology - the chronoogy to use
field - the field to skip zero on
skip - the value to skip
Method Detail

get

public int get(long millis)
Description copied from class: DateTimeField
Get the value of this field from the milliseconds.

Overrides:
get in class DelegatedDateTimeField
Parameters:
millis - the milliseconds from 1970-01-01T00:00:00Z to query
Returns:
the value of the field, in the units of the field

set

public long set(long millis,
                int value)
Description copied from class: DateTimeField
Sets a value in the milliseconds supplied.

The value of this field will be set. If the value is invalid, an exception if thrown.

If setting this field would make other fields invalid, then those fields may be changed. For example if the current date is the 31st January, and the month is set to February, the day would be invalid. Instead, the day would be changed to the closest value - the 28th/29th February as appropriate.

Overrides:
set in class DelegatedDateTimeField
Parameters:
millis - the milliseconds from 1970-01-01T00:00:00Z to set in
value - the value to set, in the units of the field
Returns:
the updated milliseconds

getMinimumValue

public int getMinimumValue()
Description copied from class: DateTimeField
Get the minimum allowable value for this field.

Overrides:
getMinimumValue in class DelegatedDateTimeField
Returns:
the minimum valid value for this field, in the units of the field
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2002–2014 Joda.org. All rights reserved.