org.joda.time

Class MutableDateTime.Property

Enclosing Class:
MutableDateTime
Implemented Interfaces:
Serializable

public static final class MutableDateTime.Property
extends AbstractReadableInstantFieldProperty

MutableDateTime.Property binds a MutableDateTime to a DateTimeField allowing powerful datetime functionality to be easily accessed.

The example below shows how to use the property to change the value of a MutableDateTime object.

 MutableDateTime dt = new MutableDateTime(1972, 12, 3, 13, 32, 19, 123);
 dt.year().add(20);
 dt.second().roundFloor().minute().set(10);
 

MutableDateTime.Propery itself is thread-safe and immutable, but the MutableDateTime being operated on is not.

Authors:
Stephen Colebourne
Brian S O'Neill
Since:
1.0

Method Summary

MutableDateTime
add(int value)
Adds a value to the millis value.
MutableDateTime
add(long value)
Adds a value to the millis value.
MutableDateTime
addWrapField(int value)
Adds a value, possibly wrapped, to the millis value.
protected Chronology
getChronology()
Gets the chronology of the datetime that this property is linked to.
DateTimeField
getField()
Gets the field being used.
protected long
getMillis()
Gets the milliseconds of the datetime that this property is linked to.
MutableDateTime
getMutableDateTime()
Gets the mutable datetime being used.
MutableDateTime
roundCeiling()
Round to the highest whole unit of this field.
MutableDateTime
roundFloor()
Round to the lowest whole unit of this field.
MutableDateTime
roundHalfCeiling()
Round to the nearest whole unit of this field, favoring the ceiling if halfway.
MutableDateTime
roundHalfEven()
Round to the nearest whole unit of this field.
MutableDateTime
roundHalfFloor()
Round to the nearest whole unit of this field, favoring the floor if halfway.
MutableDateTime
set(String text)
Sets a text value.
MutableDateTime
set(String text, Locale locale)
Sets a text value.
MutableDateTime
set(int value)
Sets a value.

Methods inherited from class org.joda.time.field.AbstractReadableInstantFieldProperty

compareTo, compareTo, equals, get, getAsShortText, getAsShortText, getAsString, getAsText, getAsText, getChronology, getDifference, getDifferenceAsLong, getDurationField, getField, getFieldType, getLeapAmount, getLeapDurationField, getMaximumShortTextLength, getMaximumTextLength, getMaximumValue, getMaximumValueOverall, getMillis, getMinimumValue, getMinimumValueOverall, getName, getRangeDurationField, hashCode, isLeap, remainder, toInterval, toString

Method Details

add

public MutableDateTime add(int value)
Adds a value to the millis value.
Parameters:
value - the value to add
Returns:
the mutable datetime being used, so calls can be chained

add

public MutableDateTime add(long value)
Adds a value to the millis value.
Parameters:
value - the value to add
Returns:
the mutable datetime being used, so calls can be chained

addWrapField

public MutableDateTime addWrapField(int value)
Adds a value, possibly wrapped, to the millis value.
Parameters:
value - the value to add
Returns:
the mutable datetime being used, so calls can be chained
See Also:
DateTimeField.addWrapField

getChronology

protected Chronology getChronology()
Gets the chronology of the datetime that this property is linked to.
Overrides:
getChronology in interface AbstractReadableInstantFieldProperty
Returns:
the chronology
Since:
1.4

getField

public DateTimeField getField()
Gets the field being used.
Overrides:
getField in interface AbstractReadableInstantFieldProperty
Returns:
the field

getMillis

protected long getMillis()
Gets the milliseconds of the datetime that this property is linked to.
Overrides:
getMillis in interface AbstractReadableInstantFieldProperty
Returns:
the milliseconds

getMutableDateTime

public MutableDateTime getMutableDateTime()
Gets the mutable datetime being used.
Returns:
the mutable datetime

roundCeiling

public MutableDateTime roundCeiling()
Round to the highest whole unit of this field.
Returns:
the mutable datetime being used, so calls can be chained

roundFloor

public MutableDateTime roundFloor()
Round to the lowest whole unit of this field.
Returns:
the mutable datetime being used, so calls can be chained

roundHalfCeiling

public MutableDateTime roundHalfCeiling()
Round to the nearest whole unit of this field, favoring the ceiling if halfway.
Returns:
the mutable datetime being used, so calls can be chained

roundHalfEven

public MutableDateTime roundHalfEven()
Round to the nearest whole unit of this field. If halfway, the ceiling is favored over the floor only if it makes this field's value even.
Returns:
the mutable datetime being used, so calls can be chained

roundHalfFloor

public MutableDateTime roundHalfFloor()
Round to the nearest whole unit of this field, favoring the floor if halfway.
Returns:
the mutable datetime being used, so calls can be chained

set

public MutableDateTime set(String text)
Sets a text value.
Parameters:
text - the text value to set
Returns:
the mutable datetime being used, so calls can be chained
See Also:
DateTimeField.set(long,java.lang.String)

set

public MutableDateTime set(String text,
                           Locale locale)
Sets a text value.
Parameters:
text - the text value to set
locale - optional locale to use for selecting a text symbol
Returns:
the mutable datetime being used, so calls can be chained
See Also:
DateTimeField.set(long,java.lang.String,java.util.Locale)

set

public MutableDateTime set(int value)
Sets a value.
Parameters:
value - the value to set.
Returns:
the mutable datetime being used, so calls can be chained

Copyright (c) 2001-2006 - Joda.org