Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   *  Copyright 2001-2005 Stephen Colebourne
   *
   *  Licensed under the Apache License, Version 2.0 (the "License");
   *  you may not use this file except in compliance with the License.
   *  You may obtain a copy of the License at
   *
   *      http://www.apache.org/licenses/LICENSE-2.0
   *
  *  Unless required by applicable law or agreed to in writing, software
  *  distributed under the License is distributed on an "AS IS" BASIS,
  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  *  See the License for the specific language governing permissions and
  *  limitations under the License.
  */
 package org.joda.time;
 
Defines the calculation engine for date and time fields. The interface defines a set of methods that manipulate a millisecond datetime with regards to a single field, such as monthOfYear or secondOfMinute.

This design is extensible so, if you wish, you can extract a different field from the milliseconds. A number of standard implementations are provided to assist.

Author(s):
Guy Allard
Stephen Colebourne
Brian S O'Neill
Since:
1.0
 
 public abstract class DateTimeField {

    
Get the type of the field.

Returns:
field type
 
     public abstract DateTimeFieldType getType();

    
Get the name of the field.

By convention, names follow a pattern of "dddOfRrr", where "ddd" represents the (singular) duration unit field name and "Rrr" represents the (singular) duration range field name. If the range field is not applicable, then the name of the field is simply the (singular) duration field name.

Returns:
field name
 
     public abstract String getName();

    
Returns true if this field is supported.

Returns:
true if this field is supported
 
     public abstract boolean isSupported();

    
Returns true if the set method is lenient. If so, it accepts values that are out of bounds. For example, a lenient day of month field accepts 32 for January, converting it to February 1.

Returns:
true if this field is lenient
 
     public abstract boolean isLenient();
 
     // Main access API
     //------------------------------------------------------------------------
     
Get the value of this field from the milliseconds.

Parameters:
instant the milliseconds from 1970-01-01T00:00:00Z to query
Returns:
the value of the field, in the units of the field
 
     public abstract int get(long instant);

    
Get the human-readable, text value of this field from the milliseconds. If the specified locale is null, the default locale is used.

Parameters:
instant the milliseconds from 1970-01-01T00:00:00Z to query
locale the locale to use for selecting a text symbol, null for default
Returns:
the text value of the field
 
     public abstract String getAsText(long instantLocale locale);

    
Get the human-readable, text value of this field from the milliseconds.

Parameters:
instant the milliseconds from 1970-01-01T00:00:00Z to query
Returns:
the text value of the field
 
     public abstract String getAsText(long instant);

    
Get the human-readable, text value of this field from a partial instant. If the specified locale is null, the default locale is used.

Parameters:
partial the partial instant to query
fieldValue the field value of this field, provided for performance
locale the locale to use for selecting a text symbol, null for default
Returns:
the text value of the field
    public abstract String getAsText(ReadablePartial partialint fieldValueLocale locale);

    
Get the human-readable, text value of this field from a partial instant. If the specified locale is null, the default locale is used.

Parameters:
partial the partial instant to query
locale the locale to use for selecting a text symbol, null for default
Returns:
the text value of the field
    public abstract String getAsText(ReadablePartial partialLocale locale);

    
Get the human-readable, text value of this field from the field value. If the specified locale is null, the default locale is used.

Parameters:
fieldValue the numeric value to convert to text
locale the locale to use for selecting a text symbol, null for default
Returns:
the text value of the field
    public abstract String getAsText(int fieldValueLocale locale);

    
Get the human-readable, short text value of this field from the milliseconds. If the specified locale is null, the default locale is used.

Parameters:
instant the milliseconds from 1970-01-01T00:00:00Z to query
locale the locale to use for selecting a text symbol, null for default
Returns:
the short text value of the field
    public abstract String getAsShortText(long instantLocale locale);

    
Get the human-readable, short text value of this field from the milliseconds.

Parameters:
instant the milliseconds from 1970-01-01T00:00:00Z to query
Returns:
the short text value of the field
    public abstract String getAsShortText(long instant);

    
Get the human-readable, short text value of this field from a partial instant. If the specified locale is null, the default locale is used.

Parameters:
partial the partial instant to query
fieldValue the field value of this field, provided for performance
locale the locale to use for selecting a text symbol, null for default
Returns:
the text value of the field
    public abstract String getAsShortText(ReadablePartial partialint fieldValueLocale locale);

    
Get the human-readable, short text value of this field from a partial instant. If the specified locale is null, the default locale is used.

Parameters:
partial the partial instant to query
locale the locale to use for selecting a text symbol, null for default
Returns:
the text value of the field
    public abstract String getAsShortText(ReadablePartial partialLocale locale);

    
Get the human-readable, short text value of this field from the field value. If the specified locale is null, the default locale is used.

Parameters:
fieldValue the numeric value to convert to text
locale the locale to use for selecting a text symbol, null for default
Returns:
the text value of the field
    public abstract String getAsShortText(int fieldValueLocale locale);

    
Adds a value (which may be negative) to the millis value, overflowing into larger fields if necessary.

The value will be added to this field. If the value is too large to be added solely to this field, larger fields will increase as required. Smaller fields should be unaffected, except where the result would be an invalid value for a smaller field. In this case the smaller field is adjusted to be in range.

For example, in the ISO chronology:
2000-08-20 add six months is 2001-02-20
2000-08-20 add twenty months is 2002-04-20
2000-08-20 add minus nine months is 1999-11-20
2001-01-31 add one month is 2001-02-28
2001-01-31 add two months is 2001-03-31

Parameters:
instant the milliseconds from 1970-01-01T00:00:00Z to add to
value the value to add, in the units of the field
Returns:
the updated milliseconds
    public abstract long add(long instantint value);

    
Adds a value (which may be negative) to the millis value, overflowing into larger fields if necessary.

Parameters:
instant the milliseconds from 1970-01-01T00:00:00Z to add to
value the long value to add, in the units of the field
Returns:
the updated milliseconds
Throws:
java.lang.IllegalArgumentException if value is too large
See also:
add(long,int)
    public abstract long add(long instantlong value);

    
Adds a value (which may be negative) to the partial instant, throwing an exception if the maximum size of the instant is reached.

The value will be added to this field, overflowing into larger fields if necessary. Smaller fields should be unaffected, except where the result would be an invalid value for a smaller field. In this case the smaller field is adjusted to be in range.

Partial instants only contain some fields. This may result in a maximum possible value, such as TimeOfDay being limited to 23:59:59:999. If this limit is breached by the add an exception is thrown.

For example, in the ISO chronology:
2000-08-20 add six months is 2000-02-20
2000-08-20 add twenty months is 2000-04-20
2000-08-20 add minus nine months is 2000-11-20
2001-01-31 add one month is 2001-02-28
2001-01-31 add two months is 2001-03-31

Parameters:
instant the partial instant
fieldIndex the index of this field in the instant
values the values of the partial instant which should be updated
valueToAdd the value to add, in the units of the field
Returns:
the passed in values
Throws:
java.lang.IllegalArgumentException if the value is invalid or the maximum instant is reached
    public abstract int[] add(ReadablePartial instantint fieldIndexint[] valuesint valueToAdd);

    
Adds a value (which may be negative) to the partial instant, wrapping the whole partial if the maximum size of the partial is reached.

The value will be added to this field, overflowing into larger fields if necessary. Smaller fields should be unaffected, except where the result would be an invalid value for a smaller field. In this case the smaller field is adjusted to be in range.

Partial instants only contain some fields. This may result in a maximum possible value, such as TimeOfDay normally being limited to 23:59:59:999. If ths limit is reached by the addition, this method will wrap back to 00:00:00.000. In fact, you would generally only use this method for classes that have a limitation such as this.

For example, in the ISO chronology:
10:20:30 add 20 minutes is 10:40:30
10:20:30 add 45 minutes is 11:05:30
10:20:30 add 16 hours is 02:20:30

Parameters:
instant the partial instant
fieldIndex the index of this field in the partial
values the values of the partial instant which should be updated
valueToAdd the value to add, in the units of the field
Returns:
the passed in values
Throws:
java.lang.IllegalArgumentException if the value is invalid or the maximum instant is reached
    public abstract int[] addWrapPartial(ReadablePartial instantint fieldIndexint[] valuesint valueToAdd);

    
Adds a value (which may be negative) to the millis value, wrapping within this field.

The value will be added to this field. If the value is too large to be added solely to this field then it wraps. Larger fields are always unaffected. Smaller fields should be unaffected, except where the result would be an invalid value for a smaller field. In this case the smaller field is adjusted to be in range.

For example, in the ISO chronology:
2000-08-20 addWrapField six months is 2000-02-20
2000-08-20 addWrapField twenty months is 2000-04-20
2000-08-20 addWrapField minus nine months is 2000-11-20
2001-01-31 addWrapField one month is 2001-02-28
2001-01-31 addWrapField two months is 2001-03-31

Parameters:
instant the milliseconds from 1970-01-01T00:00:00Z to add to
value the value to add, in the units of the field
Returns:
the updated milliseconds
    public abstract long addWrapField(long instantint value) ;

    
Adds a value (which may be negative) to the partial instant, wrapping within this field.

The value will be added to this field. If the value is too large to be added solely to this field then it wraps. Larger fields are always unaffected. Smaller fields should be unaffected, except where the result would be an invalid value for a smaller field. In this case the smaller field is adjusted to be in range.

For example, in the ISO chronology:
2000-08-20 addWrapField six months is 2000-02-20
2000-08-20 addWrapField twenty months is 2000-04-20
2000-08-20 addWrapField minus nine months is 2000-11-20
2001-01-31 addWrapField one month is 2001-02-28
2001-01-31 addWrapField two months is 2001-03-31

Parameters:
instant the partial instant
fieldIndex the index of this field in the instant
values the values of the partial instant which should be updated
valueToAdd the value to add, in the units of the field
Returns:
the passed in values
Throws:
java.lang.IllegalArgumentException if the value is invalid
    public abstract int[] addWrapField(ReadablePartial instantint fieldIndexint[] valuesint valueToAdd);

    
Computes the difference between two instants, as measured in the units of this field. Any fractional units are dropped from the result. Calling getDifference reverses the effect of calling add. In the following code:
 long instant = ...
 int v = ...
 int age = getDifference(add(instant, v), instant);
 
The value 'age' is the same as the value 'v'.

Parameters:
minuendInstant the milliseconds from 1970-01-01T00:00:00Z to subtract from
subtrahendInstant the milliseconds from 1970-01-01T00:00:00Z to subtract off the minuend
Returns:
the difference in the units of this field
    public abstract int getDifference(long minuendInstantlong subtrahendInstant);

    
Computes the difference between two instants, as measured in the units of this field. Any fractional units are dropped from the result. Calling getDifference reverses the effect of calling add. In the following code:
 long instant = ...
 long v = ...
 long age = getDifferenceAsLong(add(instant, v), instant);
 
The value 'age' is the same as the value 'v'.

Parameters:
minuendInstant the milliseconds from 1970-01-01T00:00:00Z to subtract from
subtrahendInstant the milliseconds from 1970-01-01T00:00:00Z to subtract off the minuend
Returns:
the difference in the units of this field
    public abstract long getDifferenceAsLong(long minuendInstantlong subtrahendInstant);

    
Sets a value in the milliseconds supplied.

The value of this field will be set. If the value is invalid, an exception if thrown.

If setting this field would make other fields invalid, then those fields may be changed. For example if the current date is the 31st January, and the month is set to February, the day would be invalid. Instead, the day would be changed to the closest value - the 28th/29th February as appropriate.

Parameters:
instant the milliseconds from 1970-01-01T00:00:00Z to set in
value the value to set, in the units of the field
Returns:
the updated milliseconds
Throws:
java.lang.IllegalArgumentException if the value is invalid
    public abstract long set(long instantint value);

    
Sets a value using the specified partial instant.

The value of this field (specified by the index) will be set. If the value is invalid, an exception if thrown.

If setting this field would make other fields invalid, then those fields may be changed. For example if the current date is the 31st January, and the month is set to February, the day would be invalid. Instead, the day would be changed to the closest value - the 28th/29th February as appropriate.

Parameters:
instant the partial instant
fieldIndex the index of this field in the instant
values the values of the partial instant which should be updated
newValue the value to set, in the units of the field
Returns:
the passed in values
Throws:
java.lang.IllegalArgumentException if the value is invalid
    public abstract int[] set(ReadablePartial instantint fieldIndexint[] valuesint newValue);

    
Sets a value in the milliseconds supplied from a human-readable, text value. If the specified locale is null, the default locale is used.

If setting this field would make other fields invalid, then those fields may be changed. For example if the current date is the 31st January, and the month is set to February, the day would be invalid. Instead, the day would be changed to the closest value - the 28th/29th February as appropriate.

Parameters:
instant the milliseconds from 1970-01-01T00:00:00Z to set in
text the text value to set
locale the locale to use for selecting a text symbol, null for default
Returns:
the updated milliseconds
Throws:
java.lang.IllegalArgumentException if the text value is invalid
    public abstract long set(long instantString textLocale locale);

    
Sets a value in the milliseconds supplied from a human-readable, text value.

If setting this field would make other fields invalid, then those fields may be changed. For example if the current date is the 31st January, and the month is set to February, the day would be invalid. Instead, the day would be changed to the closest value - the 28th/29th February as appropriate.

Parameters:
instant the milliseconds from 1970-01-01T00:00:00Z to set in
text the text value to set
Returns:
the updated milliseconds
Throws:
java.lang.IllegalArgumentException if the text value is invalid
    public abstract long set(long instantString text);

    
Sets a value in the milliseconds supplied from a human-readable, text value. If the specified locale is null, the default locale is used.

If setting this field would make other fields invalid, then those fields may be changed. For example if the current date is the 31st January, and the month is set to February, the day would be invalid. Instead, the day would be changed to the closest value - the 28th/29th February as appropriate.

Parameters:
instant the partial instant
fieldIndex the index of this field in the instant
values the values of the partial instant which should be updated
text the text value to set
locale the locale to use for selecting a text symbol, null for default
Returns:
the passed in values
Throws:
java.lang.IllegalArgumentException if the text value is invalid
    public abstract int[] set(ReadablePartial instantint fieldIndexint[] valuesString textLocale locale);
    // Extra information API
    //------------------------------------------------------------------------
    
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 if field has no duration
    public abstract DurationField getDurationField();

    
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 abstract DurationField getRangeDurationField();

    
Returns whether this field is 'leap' for the specified instant.

For example, a leap year would return true, a non leap year would return false.

Parameters:
instant the instant to check for leap status
Returns:
true if the field is 'leap'
    public abstract boolean isLeap(long instant);

    
Gets the amount by which this field is 'leap' for the specified instant.

For example, a leap year would return one, a non leap year would return zero.

Parameters:
instant the instant to check for leap status
Returns:
the amount, in units of the leap duration field, that the field is leap
    public abstract int getLeapAmount(long instant);

    
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.

Returns:
the leap duration field if field can be leap, null if it can't
    public abstract DurationField getLeapDurationField();

    
Get the minimum allowable value for this field.

Returns:
the minimum valid value for this field, in the units of the field
    public abstract int getMinimumValue();

    
Get the minimum value for this field evaluated at the specified time.

Parameters:
instant the milliseconds from 1970-01-01T00:00:00Z to query
Returns:
the minimum value for this field, in the units of the field
    public abstract int getMinimumValue(long instant);

    
Get the minimum value for this field evaluated at the specified time.

Parameters:
instant the partial instant to query
Returns:
the minimum value for this field, in the units of the field
    public abstract int getMinimumValue(ReadablePartial instant);

    
Get the minimum value for this field using the partial instant and the specified values.

Parameters:
instant the partial instant to query
values the values to use
Returns:
the minimum value for this field, in the units of the field
    public abstract int getMinimumValue(ReadablePartial instantint[] values);

    
Get the maximum allowable value for this field.

Returns:
the maximum valid value for this field, in the units of the field
    public abstract int getMaximumValue();

    
Get the maximum value for this field evaluated at the specified time.

Parameters:
instant the milliseconds from 1970-01-01T00:00:00Z to query
Returns:
the maximum value for this field, in the units of the field
    public abstract int getMaximumValue(long instant);

    
Get the maximum value for this field evaluated at the specified time.

Parameters:
instant the partial instant to query
Returns:
the maximum value for this field, in the units of the field
    public abstract int getMaximumValue(ReadablePartial instant);

    
Get the maximum value for this field using the partial instant and the specified values.

Parameters:
instant the partial instant to query
values the values to use
Returns:
the maximum value for this field, in the units of the field
    public abstract int getMaximumValue(ReadablePartial instantint[] values);

    
Get the maximum text value for this field.

Parameters:
locale the locale to use for selecting a text symbol
Returns:
the maximum text length
    public abstract int getMaximumTextLength(Locale locale);

    
Get the maximum short text value for this field.

Parameters:
locale the locale to use for selecting a text symbol
Returns:
the maximum short text length
    public abstract int getMaximumShortTextLength(Locale locale);
    // Calculation API
    //------------------------------------------------------------------------
    
Round to the lowest whole unit of this field. After rounding, the value of this field and all fields of a higher magnitude are retained. The fractional millis that cannot be expressed in whole increments of this field are set to minimum.

For example, a datetime of 2002-11-02T23:34:56.789, rounded to the lowest whole hour is 2002-11-02T23:00:00.000.

Parameters:
instant the milliseconds from 1970-01-01T00:00:00Z to round
Returns:
rounded milliseconds
    public abstract long roundFloor(long instant);

    
Round to the highest whole unit of this field. The value of this field and all fields of a higher magnitude may be incremented in order to achieve this result. The fractional millis that cannot be expressed in whole increments of this field are set to minimum.

For example, a datetime of 2002-11-02T23:34:56.789, rounded to the highest whole hour is 2002-11-03T00:00:00.000.

Parameters:
instant the milliseconds from 1970-01-01T00:00:00Z to round
Returns:
rounded milliseconds
    public abstract long roundCeiling(long instant);

    
Round to the nearest whole unit of this field. If the given millisecond value is closer to the floor or is exactly halfway, this function behaves like roundFloor. If the millisecond value is closer to the ceiling, this function behaves like roundCeiling.

Parameters:
instant the milliseconds from 1970-01-01T00:00:00Z to round
Returns:
rounded milliseconds
    public abstract long roundHalfFloor(long instant);

    
Round to the nearest whole unit of this field. If the given millisecond value is closer to the floor, this function behaves like roundFloor. If the millisecond value is closer to the ceiling or is exactly halfway, this function behaves like roundCeiling.

Parameters:
instant the milliseconds from 1970-01-01T00:00:00Z to round
Returns:
rounded milliseconds
    public abstract long roundHalfCeiling(long instant);

    
Round to the nearest whole unit of this field. If the given millisecond value is closer to the floor, this function behaves like roundFloor. If the millisecond value is closer to the ceiling, this function behaves like roundCeiling.

If the millisecond value is exactly halfway between the floor and ceiling, the ceiling is chosen over the floor only if it makes this field's value even.

Parameters:
instant the milliseconds from 1970-01-01T00:00:00Z to round
Returns:
rounded milliseconds
    public abstract long roundHalfEven(long instant);

    
Returns the fractional duration milliseconds of this field. In other words, calling remainder returns the duration that roundFloor would subtract.

For example, on a datetime of 2002-11-02T23:34:56.789, the remainder by hour is 34 minutes and 56.789 seconds.

Parameters:
instant the milliseconds from 1970-01-01T00:00:00Z to get the remainder
Returns:
remainder duration, in milliseconds
    public abstract long remainder(long instant);

    
Get a suitable debug string.

Returns:
debug string
    public abstract String toString();
    
New to GrepCode? Check out our FAQ X