Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.joda.time.field.AbstractReadableInstantFieldProperty
public abstract class AbstractReadableInstantFieldProperty
extends java.lang.Object
implements Serializable
Constructor Summary | |
|
Method Summary | |
int |
|
int |
|
boolean |
|
int |
|
String |
|
String |
|
String |
|
String |
|
String |
|
protected Chronology |
|
int |
|
long |
|
DurationField |
|
abstract DateTimeField |
|
DateTimeFieldType |
|
int |
|
DurationField |
|
int |
|
int |
|
int |
|
int |
|
protected abstract long |
|
int |
|
int |
|
String |
|
DurationField |
|
int |
|
boolean |
|
long |
|
Interval |
|
String |
|
public int compareTo(ReadableInstant instant)
Compare this field to the same field on another instant. The comparison is based on the value of the same field type, irrespective of any difference in chronology. Thus, if this property represents the hourOfDay field, then the hourOfDay field of the other instant will be queried whether in the same chronology or not.
- Parameters:
instant
- the instant to compare to
- Returns:
- negative value if this is less, 0 if equal, or positive value if greater
public int compareTo(ReadablePartial partial)
Compare this field to the same field on another partial instant. The comparison is based on the value of the same field type, irrespective of any difference in chronology. Thus, if this property represents the hourOfDay field, then the hourOfDay field of the other partial will be queried whether in the same chronology or not.
- Parameters:
partial
- the partial to compare to
- Returns:
- negative value if this is less, 0 if equal, or positive value if greater
public boolean equals(Object object)
Compares this property to another.
- Parameters:
object
- the object to compare to
- Returns:
- true if equal
public int get()
Gets the value of this property from the instant. For example, the following two lines of code are equivalent:datetime.getDayOfMonth(); datetime.dayOfMonth().get();
- Returns:
- the current value
- See Also:
DateTimeField.get(long)
public String getAsShortText()
Gets the short textual value of this property from the instant as a string in the default locale. This method returns the value converted to aString
returning the appropriate textual description wherever possible. Thus, a day of week of 1 would return 'Mon' in English.
- Returns:
- the current text value
- See Also:
DateTimeField.getAsShortText
public String getAsShortText(Locale locale)
Gets the short textual value of this property from the instant as a string in the specified locale. This method returns the value converted to aString
returning the appropriate textual description wherever possible. Thus, a day of week of 1 would return 'Mon' in English.
- Parameters:
locale
- locale to use for selecting a text symbol, null means default
- Returns:
- the current text value
- See Also:
DateTimeField.getAsShortText
public String getAsString()
Gets the value of this property from the instant as a string. This method returns the value converted to aString
usingInteger.toString
. This method does NOT return textual descriptions such as 'Monday' or 'January'. SeegetAsText()
andgetAsShortText()
for those.
- Returns:
- the current value
- Since:
- 1.1
- See Also:
DateTimeField.get(long)
public String getAsText()
Gets the textual value of this property from the instant as a string in the default locale. This method returns the value converted to aString
returning the appropriate textual description wherever possible. Thus, a day of week of 1 would return 'Monday' in English.
- Returns:
- the current text value
- See Also:
DateTimeField.getAsText
public String getAsText(Locale locale)
Gets the textual value of this property from the instant as a string in the specified locale. This method returns the value converted to aString
returning the appropriate textual description wherever possible. Thus, a day of week of 1 would return 'Monday' in English.
- Parameters:
locale
- locale to use for selecting a text symbol, null means default
- Returns:
- the current text value
- See Also:
DateTimeField.getAsText
protected Chronology getChronology()
Gets the chronology of the datetime that this property is linked to. This implementation throws UnsupportedOperationException, and must be implemented by subclasses to enable the equals() and hashCode() methods.
- Returns:
- the chronology
- Since:
- 1.4
public int getDifference(ReadableInstant instant)
Returns the difference between this field property instant and the one passed in, in the units of this field. The sign of the difference matches that of compareTo. In other words, this field property's instant is the minuend.
- Parameters:
instant
- the subtrahend, null means now
- Returns:
- the difference in the units of this field
public long getDifferenceAsLong(ReadableInstant instant)
Returns the difference between this field property instant and the one passed in, in the units of this field. The sign of the difference matches that of compareTo. In other words, this field property's instant is the minuend.
- Parameters:
instant
- the subtrahend, null means now
- Returns:
- the difference in the units of this field
public DurationField getDurationField()
Returns the duration per unit value of this field. For example, if this field represents "hour of day", then the duration is an hour.
- Returns:
- the duration of this field, or UnsupportedDurationField
public DateTimeFieldType getFieldType()
Gets the field type being used.
- Returns:
- the field type
public int getLeapAmount()
Gets the amount by which this field is leap.
- Returns:
- the amount by which the field is leap
- See Also:
DateTimeField.getLeapAmount(long)
public DurationField getLeapDurationField()
If this field were to leap, then it would be in units described by the returned duration. If this field doesn't ever leap, null is returned.
public int getMaximumShortTextLength(Locale locale)
Gets the maximum short text length for the field.
- Parameters:
locale
- optional locale to use for selecting a text symbol
- Returns:
- the maximum length
public int getMaximumTextLength(Locale locale)
Gets the maximum text length for the field.
- Parameters:
locale
- optional locale to use for selecting a text symbol
- Returns:
- the maximum length
public int getMaximumValue()
Gets the maximum value for the field.
- Returns:
- the maximum value
- See Also:
DateTimeField.getMaximumValue
public int getMaximumValueOverall()
Gets the maximum value for the field ignoring the current time.
- Returns:
- the maximum value
- See Also:
DateTimeField.getMaximumValue
protected abstract long getMillis()
Gets the milliseconds of the datetime that this property is linked to.
- Returns:
- the milliseconds
public int getMinimumValue()
Gets the minimum value for the field.
- Returns:
- the minimum value
- See Also:
DateTimeField.getMinimumValue
public int getMinimumValueOverall()
Gets the minimum value for the field ignoring the current time.
- Returns:
- the minimum value
- See Also:
DateTimeField.getMinimumValue
public String getName()
Gets the name of the field.
- Returns:
- the field name
public DurationField getRangeDurationField()
Returns the range duration of this field. For example, if this field represents "hour of day", then the range duration is a day.
- Returns:
- the range duration of this field, or null if field has no range
public int hashCode()
Returns a hashcode compatible with the equals method.
- Returns:
- the hashcode
public boolean isLeap()
Gets whether this field is leap.
- Returns:
- true if a leap field
- See Also:
DateTimeField.isLeap(long)
public long remainder()
Returns the fractional duration milliseconds of this field.
- Returns:
- remainder duration, in milliseconds
- See Also:
DateTimeField.remainder(long)
public Interval toInterval()
Returns the interval that represents the range of the minimum and maximum values of this field. For example,datetime.monthOfYear().toInterval()
will return an interval over the whole month.
- Returns:
- the interval of this field
- Since:
- 1.2
public String toString()
Output a debugging string.
- Returns:
- debugging string