Class TimeOfDay.Property
- All Implemented Interfaces:
Serializable
- Enclosing class:
- TimeOfDay
TimeOfDay
.
This class binds a TimeOfDay
to a DateTimeField
.
- Since:
- 1.0
- Author:
- Stephen Colebourne
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionaddNoWrapToCopy
(int valueToAdd) Deprecated.Adds to the value of this field in a copy of this TimeOfDay, throwing an Exception if the bounds are exceeded.addToCopy
(int valueToAdd) Deprecated.Adds to the value of this field in a copy of this TimeOfDay, wrapping to what would be the next day if necessary.addWrapFieldToCopy
(int valueToAdd) Deprecated.Adds to the value of this field in a copy of this TimeOfDay wrapping within this field if the maximum value is reached.int
get()
Deprecated.Gets the value of this field.getField()
Deprecated.Gets the field that this property uses.protected ReadablePartial
Deprecated.Gets the partial that this property belongs to.Deprecated.Gets the partial that this property belongs to.setCopy
(int value) Deprecated.Sets this field in a copy of the TimeOfDay.Deprecated.Sets this field in a copy of the TimeOfDay to a parsed text value.Deprecated.Sets this field in a copy of the TimeOfDay to a parsed text value.Deprecated.Returns a new TimeOfDay with this field set to the maximum value for this field.Deprecated.Returns a new TimeOfDay with this field set to the minimum value for this field.Methods inherited from class org.joda.time.field.AbstractPartialFieldProperty
compareTo, compareTo, equals, getAsShortText, getAsShortText, getAsString, getAsText, getAsText, getDurationField, getFieldType, getMaximumShortTextLength, getMaximumTextLength, getMaximumValue, getMaximumValueOverall, getMinimumValue, getMinimumValueOverall, getName, getRangeDurationField, hashCode, toString
-
Method Details
-
getField
Deprecated.Gets the field that this property uses.- Specified by:
getField
in classAbstractPartialFieldProperty
- Returns:
- the field
-
getReadablePartial
Deprecated.Gets the partial that this property belongs to.- Specified by:
getReadablePartial
in classAbstractPartialFieldProperty
- Returns:
- the partial
-
getTimeOfDay
Deprecated.Gets the partial that this property belongs to.- Returns:
- the partial
-
get
public int get()Deprecated.Gets the value of this field.- Specified by:
get
in classAbstractPartialFieldProperty
- Returns:
- the field value
-
addToCopy
Deprecated.Adds to the value of this field in a copy of this TimeOfDay, wrapping to what would be the next day if necessary.The value will be added to this field. If the value is too large to be added solely to this field then it will affect larger fields. Smaller fields are unaffected.
If the result would be too large, beyond 23:59:59:999, then the calculation wraps to 00:00:00.000. For the alternate strict behaviour with no wrapping see
addNoWrapToCopy(int)
.The TimeOfDay attached to this property is unchanged by this call. Instead, a new instance is returned.
- Parameters:
valueToAdd
- the value to add to the field in the copy- Returns:
- a copy of the TimeOfDay with the field value changed
- Throws:
IllegalArgumentException
- if the value isn't valid
-
addNoWrapToCopy
Deprecated.Adds to the value of this field in a copy of this TimeOfDay, throwing an Exception if the bounds are exceeded.The value will be added to this field. If the value is too large to be added solely to this field then it will affect larger fields. Smaller fields are unaffected.
If the result would be too large (beyond 23:59:59:999) or too small (less than 00:00:00.000) then an Exception is thrown. For the alternate behaviour which wraps to the next 'day', see
addToCopy(int)
.The TimeOfDay attached to this property is unchanged by this call. Instead, a new instance is returned.
- Parameters:
valueToAdd
- the value to add to the field in the copy- Returns:
- a copy of the TimeOfDay with the field value changed
- Throws:
IllegalArgumentException
- if the value isn't valid
-
addWrapFieldToCopy
Deprecated.Adds to the value of this field in a copy of this TimeOfDay wrapping within this field if the maximum value is reached.The value will be added to this field. If the value is too large to be added solely to this field then it wraps within this field. Other fields are unaffected.
For example,
12:59:37
addWrapField one minute returns12:00:37
.The TimeOfDay attached to this property is unchanged by this call. Instead, a new instance is returned.
- Parameters:
valueToAdd
- the value to add to the field in the copy- Returns:
- a copy of the TimeOfDay with the field value changed
- Throws:
IllegalArgumentException
- if the value isn't valid
-
setCopy
Deprecated.Sets this field in a copy of the TimeOfDay.The TimeOfDay attached to this property is unchanged by this call. Instead, a new instance is returned.
- Parameters:
value
- the value to set the field in the copy to- Returns:
- a copy of the TimeOfDay with the field value changed
- Throws:
IllegalArgumentException
- if the value isn't valid
-
setCopy
Deprecated.Sets this field in a copy of the TimeOfDay to a parsed text value.The TimeOfDay attached to this property is unchanged by this call. Instead, a new instance is returned.
- Parameters:
text
- the text value to setlocale
- optional locale to use for selecting a text symbol- Returns:
- a copy of the TimeOfDay with the field value changed
- Throws:
IllegalArgumentException
- if the text value isn't valid
-
setCopy
Deprecated.Sets this field in a copy of the TimeOfDay to a parsed text value.The TimeOfDay attached to this property is unchanged by this call. Instead, a new instance is returned.
- Parameters:
text
- the text value to set- Returns:
- a copy of the TimeOfDay with the field value changed
- Throws:
IllegalArgumentException
- if the text value isn't valid
-
withMaximumValue
Deprecated.Returns a new TimeOfDay with this field set to the maximum value for this field.The TimeOfDay attached to this property is unchanged by this call.
- Returns:
- a copy of the TimeOfDay with this field set to its maximum
- Since:
- 1.2
-
withMinimumValue
Deprecated.Returns a new TimeOfDay with this field set to the minimum value for this field.The TimeOfDay attached to this property is unchanged by this call.
- Returns:
- a copy of the TimeOfDay with this field set to its minimum
- Since:
- 1.2
-