org.joda.time
Class DateMidnight.Property
- DateMidnight
- Serializable
public static final class DateMidnight.Property
DateMidnight.Property binds a DateMidnight to a DateTimeField allowing powerful
datetime functionality to be easily accessed.
The simplest use of this class is as an alternative get method, here used to
get the year '1972' (as an int) and the month 'December' (as a String).
DateMidnight dt = new DateMidnight(1972, 12, 3);
int year = dt.year().get();
String monthStr = dt.monthOfYear().getAsText();
Methods are also provided that allow date modification. These return new instances
of DateMidnight - they do not modify the original. The example below yields two
independent immutable date objects 20 years apart.
DateMidnight dt = new DateMidnight(1972, 12, 3);
DateMidnight dt20 = dt.year().addToCopy(20);
Serious modification of dates (ie. more than just changing one or two fields)
should use the
MutableDateTime
class.
DateMidnight.Property itself is thread-safe and immutable.
- Stephen Colebourne
- Brian S O'Neill
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 |
addToCopy
public DateMidnight addToCopy(int value)
Adds to this field in a copy of this DateMidnight.
The DateMidnight attached to this property is unchanged by this call.
This operation is faster than converting a DateMidnight to a MutableDateTime
and back again when setting one field. When setting multiple fields,
it is generally quicker to make the conversion to MutableDateTime.
value
- the value to add to the field in the copy
- a copy of the DateMidnight with the field value changed
addToCopy
public DateMidnight addToCopy(long value)
Adds to this field in a copy of this DateMidnight.
The DateMidnight attached to this property is unchanged by this call.
This operation is faster than converting a DateMidnight to a MutableDateTime
and back again when setting one field. When setting multiple fields,
it is generally quicker to make the conversion to MutableDateTime.
value
- the value to add to the field in the copy
- a copy of the DateMidnight with the field value changed
addWrapFieldToCopy
public DateMidnight addWrapFieldToCopy(int value)
Adds to this field, possibly wrapped, in a copy of this DateMidnight.
A wrapped operation only changes this field.
Thus 31st January addWrapField one day goes to the 1st January.
The DateMidnight attached to this property is unchanged by this call.
This operation is faster than converting a DateMidnight to a MutableDateTime
and back again when setting one field. When setting multiple fields,
it is generally quicker to make the conversion to MutableDateTime.
value
- the value to add to the field in the copy
- a copy of the DateMidnight with the field value changed
getDateMidnight
public DateMidnight getDateMidnight()
Gets the datetime being used.
roundCeilingCopy
public DateMidnight roundCeilingCopy()
Rounds to the highest whole unit of this field on a copy of this DateMidnight.
- a copy of the DateMidnight with the field value changed
roundFloorCopy
public DateMidnight roundFloorCopy()
Rounds to the lowest whole unit of this field on a copy of this DateMidnight.
- a copy of the DateMidnight with the field value changed
roundHalfCeilingCopy
public DateMidnight roundHalfCeilingCopy()
Rounds to the nearest whole unit of this field on a copy of this DateMidnight,
favoring the ceiling if halfway.
- a copy of the DateMidnight with the field value changed
roundHalfEvenCopy
public DateMidnight roundHalfEvenCopy()
Rounds to the nearest whole unit of this field on a copy of this DateMidnight.
If halfway, the ceiling is favored over the floor only if it makes this field's value even.
- a copy of the DateMidnight with the field value changed
roundHalfFloorCopy
public DateMidnight roundHalfFloorCopy()
Rounds to the nearest whole unit of this field on a copy of this DateMidnight,
favoring the floor if halfway.
- a copy of the DateMidnight with the field value changed
setCopy
public DateMidnight setCopy(String text)
Sets this field in a copy of the DateMidnight to a parsed text value.
The DateMidnight attached to this property is unchanged by this call.
This operation is faster than converting a DateMidnight to a MutableDateTime
and back again when setting one field. When setting multiple fields,
it is generally quicker to make the conversion to MutableDateTime.
text
- the text value to set
- a copy of the DateMidnight with the field value changed
setCopy
public DateMidnight setCopy(String text,
Locale locale)
Sets this field in a copy of the DateMidnight to a parsed text value.
The DateMidnight attached to this property is unchanged by this call.
This operation is faster than converting a DateMidnight to a MutableDateTime
and back again when setting one field. When setting multiple fields,
it is generally quicker to make the conversion to MutableDateTime.
text
- the text value to setlocale
- optional locale to use for selecting a text symbol
- a copy of the DateMidnight with the field value changed
setCopy
public DateMidnight setCopy(int value)
Sets this field in a copy of the DateMidnight.
The DateMidnight attached to this property is unchanged by this call.
This operation is faster than converting a DateMidnight to a MutableDateTime
and back again when setting one field. When setting multiple fields,
it is generally quicker to make the conversion to MutableDateTime.
value
- the value to set the field in the copy to
- a copy of the DateMidnight with the field value changed
withMaximumValue
public DateMidnight withMaximumValue()
Returns a new DateMidnight with this field set to the maximum value
for this field.
This operation is useful for obtaining a DateTime on the last day
of the month, as month lengths vary.
DateMidnight lastDayOfMonth = dt.dayOfMonth().withMaximumValue();
The DateMidnight attached to this property is unchanged by this call.
- a copy of the DateMidnight with this field set to its maximum
withMinimumValue
public DateMidnight withMinimumValue()
Returns a new DateMidnight with this field set to the minimum value
for this field.
The DateMidnight attached to this property is unchanged by this call.
- a copy of the DateMidnight with this field set to its minimum
Copyright (c) 2001-2006 - Joda.org