public static class

TimeOfDay.Property

extends AbstractPartialFieldProperty
implements Serializable
java.lang.Object
   ↳ org.joda.time.field.AbstractPartialFieldProperty
     ↳ org.joda.time.TimeOfDay.Property

This class is deprecated.
Use LocalTime which has a much better internal implementation

Class Overview

The property class for TimeOfDay.

This class binds a TimeOfDay to a DateTimeField.

Summary

Public Methods
TimeOfDay addNoWrapToCopy(int valueToAdd)
Adds to the value of this field in a copy of this TimeOfDay, throwing an Exception if the bounds are exceeded.
TimeOfDay addToCopy(int valueToAdd)
Adds to the value of this field in a copy of this TimeOfDay, wrapping to what would be the next day if necessary.
TimeOfDay addWrapFieldToCopy(int valueToAdd)
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()
Gets the value of this field.
DateTimeField getField()
Gets the field that this property uses.
TimeOfDay getTimeOfDay()
Gets the partial that this property belongs to.
TimeOfDay setCopy(String text, Locale locale)
Sets this field in a copy of the TimeOfDay to a parsed text value.
TimeOfDay setCopy(int value)
Sets this field in a copy of the TimeOfDay.
TimeOfDay setCopy(String text)
Sets this field in a copy of the TimeOfDay to a parsed text value.
TimeOfDay withMaximumValue()
Returns a new TimeOfDay with this field set to the maximum value for this field.
TimeOfDay withMinimumValue()
Returns a new TimeOfDay with this field set to the minimum value for this field.
Protected Methods
ReadablePartial getReadablePartial()
Gets the partial that this property belongs to.
[Expand]
Inherited Methods
From class org.joda.time.field.AbstractPartialFieldProperty
From class java.lang.Object

Public Methods

public TimeOfDay addNoWrapToCopy (int valueToAdd)

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 Execption 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

public TimeOfDay addToCopy (int valueToAdd)

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

public TimeOfDay addWrapFieldToCopy (int valueToAdd)

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 returns 12: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

public int get ()

Gets the value of this field.

Returns
  • the field value

public DateTimeField getField ()

Gets the field that this property uses.

Returns
  • the field

public TimeOfDay getTimeOfDay ()

Gets the partial that this property belongs to.

Returns
  • the partial

public TimeOfDay setCopy (String text, Locale locale)

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
locale 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

public TimeOfDay setCopy (int value)

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

public TimeOfDay setCopy (String text)

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

public TimeOfDay withMaximumValue ()

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

public TimeOfDay withMinimumValue ()

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

Protected Methods

protected ReadablePartial getReadablePartial ()

Gets the partial that this property belongs to.

Returns
  • the partial