Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
   /*
    *  Copyright 2001-2011 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;
  
  import java.util.Date;
  import java.util.HashSet;
  import java.util.Locale;
  import java.util.Set;
  
  import  org.joda.convert.FromString;
  import  org.joda.convert.ToString;
LocalTime is an immutable time class representing a time without a time zone.

LocalTime implements the ReadablePartial interface. To do this, the interface methods focus on the key fields - HourOfDay, MinuteOfHour, SecondOfMinute and MillisOfSecond. However, all time fields may in fact be queried.

Calculations on LocalTime are performed using a Chronology. This chronology will be set internally to be in the UTC time zone for all calculations.

Each individual field can be queried in two ways:

  • getHourOfDay()
  • hourOfDay().get()
The second technique also provides access to other useful methods on the field:
  • numeric value
  • text value
  • short text value
  • maximum/minimum values
  • add/subtract
  • set
  • rounding

LocalTime is thread-safe and immutable, provided that the Chronology is as well. All standard Chronology classes supplied are thread-safe and immutable.

Author(s):
Stephen Colebourne
Since:
1.3
  
  public final class LocalTime
          extends BaseLocal
          implements ReadablePartialSerializable {

    
Serialization lock
  
      private static final long serialVersionUID = -12873158713873L;

    
Constant for midnight.
  
      public static final LocalTime MIDNIGHT = new LocalTime(0, 0, 0, 0);

    
The index of the hourOfDay field in the field array
  
      private static final int HOUR_OF_DAY = 0;
    
The index of the minuteOfHour field in the field array
  
      private static final int MINUTE_OF_HOUR = 1;
    
The index of the secondOfMinute field in the field array
  
      private static final int SECOND_OF_MINUTE = 2;
    
The index of the millisOfSecond field in the field array
  
      private static final int MILLIS_OF_SECOND = 3;
    
Set of known duration types.
  
      private static final Set<DurationFieldTypeTIME_DURATION_TYPES = new HashSet<DurationFieldType>();
      static {
          .add(DurationFieldType.millis());
          .add(DurationFieldType.seconds());
          .add(DurationFieldType.minutes());
         .add(DurationFieldType.hours());
     }

    
The local millis from 1970-01-01T00:00:00
 
     private final long iLocalMillis;
    
The chronology to use, in UTC
 
     private final Chronology iChronology;
 
     //-----------------------------------------------------------------------
     
Obtains a LocalTime set to the current system millisecond time using ISOChronology in the default time zone. The resulting object does not use the zone.

Returns:
the current time, not null
Since:
2.0
 
     public static LocalTime now() {
         return new LocalTime();
     }

    
Obtains a LocalTime set to the current system millisecond time using ISOChronology in the specified time zone. The resulting object does not use the zone.

Parameters:
zone the time zone, not null
Returns:
the current time, not null
Since:
2.0
 
     public static LocalTime now(DateTimeZone zone) {
         if (zone == null) {
             throw new NullPointerException("Zone must not be null");
         }
         return new LocalTime(zone);
     }

    
Obtains a LocalTime set to the current system millisecond time using the specified chronology. The resulting object does not use the zone.

Parameters:
chronology the chronology, not null
Returns:
the current time, not null
Since:
2.0
 
     public static LocalTime now(Chronology chronology) {
         if (chronology == null) {
             throw new NullPointerException("Chronology must not be null");
         }
         return new LocalTime(chronology);
     }
 
     //-----------------------------------------------------------------------
     
Parses a LocalTime from the specified string.

This uses ISODateTimeFormat.localTimeParser().

Parameters:
str the string to parse, not null
Since:
2.0
 
     @FromString
     public static LocalTime parse(String str) {
         return parse(str, ISODateTimeFormat.localTimeParser());
     }

    
Parses a LocalTime from the specified string using a formatter.

Parameters:
str the string to parse, not null
formatter the formatter to use, not null
Since:
2.0
 
     public static LocalTime parse(String strDateTimeFormatter formatter) {
         return formatter.parseLocalTime(str);
     }
 
     //-----------------------------------------------------------------------
     
Constructs a LocalTime from the specified millis of day using the ISO chronology.

The millisOfDay value may exceed the number of millis in one day, but additional days will be ignored. This method uses the UTC time zone internally.

Parameters:
millisOfDay the number of milliseconds into a day to convert
 
     public static LocalTime fromMillisOfDay(long millisOfDay) {
         return fromMillisOfDay(millisOfDaynull);
     }

    
Constructs a LocalTime from the specified millis of day using the specified chronology.

The millisOfDay value may exceed the number of millis in one day, but additional days will be ignored. This method uses the UTC time zone internally.

Parameters:
millisOfDay the number of milliseconds into a day to convert
chrono the chronology, null means ISO chronology
 
     public static LocalTime fromMillisOfDay(long millisOfDayChronology chrono) {
         chrono = DateTimeUtils.getChronology(chrono).withUTC();
         return new LocalTime(millisOfDaychrono);
     }
 
     //-----------------------------------------------------------------------
     
Constructs a LocalTime from a java.util.Calendar using exactly the same field values.

Each field is queried from the Calendar and assigned to the LocalTime. This is useful if you have been using the Calendar as a local time, ignoring the zone.

One advantage of this method is that this method is unaffected if the version of the time zone data differs between the JDK and Joda-Time. That is because the local field values are transferred, calculated using the JDK time zone data and without using the Joda-Time time zone data.

This factory method ignores the type of the calendar and always creates a LocalTime with ISO chronology. It is expected that you will only pass in instances of GregorianCalendar however this is not validated.

Parameters:
calendar the Calendar to extract fields from
Returns:
the created LocalTime
Throws:
IllegalArgumentException if the calendar is null
IllegalArgumentException if the date is invalid for the ISO chronology
 
     public static LocalTime fromCalendarFields(Calendar calendar) {
         if (calendar == null) {
             throw new IllegalArgumentException("The calendar must not be null");
         }
         return new LocalTime(
             calendar.get(.),
             calendar.get(.),
             calendar.get(.),
             calendar.get(.)
         );
     }

    
Constructs a LocalTime from a java.util.Date using exactly the same field values.

Each field is queried from the Date and assigned to the LocalTime. This is useful if you have been using the Date as a local time, ignoring the zone.

One advantage of this method is that this method is unaffected if the version of the time zone data differs between the JDK and Joda-Time. That is because the local field values are transferred, calculated using the JDK time zone data and without using the Joda-Time time zone data.

This factory method always creates a LocalTime with ISO chronology.

Parameters:
date the Date to extract fields from
Returns:
the created LocalTime
Throws:
IllegalArgumentException if the calendar is null
IllegalArgumentException if the date is invalid for the ISO chronology
 
     @SuppressWarnings("deprecation")
     public static LocalTime fromDateFields(Date date) {
         if (date == null) {
             throw new IllegalArgumentException("The date must not be null");
         }
         return new LocalTime(
             date.getHours(),
             date.getMinutes(),
             date.getSeconds(),
             (((int) (date.getTime() % 1000)) + 1000) % 1000
         );
     }
 
     //-----------------------------------------------------------------------
     
Constructs an instance set to the current local time evaluated using ISO chronology in the default zone.

Once the constructor is completed, the zone is no longer used.

See also:
now()
 
     public LocalTime() {
         this(DateTimeUtils.currentTimeMillis(), ISOChronology.getInstance());
     }

    
Constructs an instance set to the current local time evaluated using ISO chronology in the specified zone.

If the specified time zone is null, the default zone is used. Once the constructor is completed, the zone is no longer used.

Parameters:
zone the time zone, null means default zone
See also:
now(DateTimeZone)
 
     public LocalTime(DateTimeZone zone) {
         this(DateTimeUtils.currentTimeMillis(), ISOChronology.getInstance(zone));
     }

    
Constructs an instance set to the current local time evaluated using specified chronology and zone.

If the chronology is null, ISO chronology in the default time zone is used. Once the constructor is completed, the zone is no longer used.

Parameters:
chronology the chronology, null means ISOChronology in default zone
See also:
now(Chronology)
 
     public LocalTime(Chronology chronology) {
         this(DateTimeUtils.currentTimeMillis(), chronology);
     }
 
     //-----------------------------------------------------------------------
     
Constructs an instance set to the local time defined by the specified instant evaluated using ISO chronology in the default zone.

Once the constructor is completed, the zone is no longer used.

Parameters:
instant the milliseconds from 1970-01-01T00:00:00Z
 
     public LocalTime(long instant) {
         this(instant, ISOChronology.getInstance());
     }

    
Constructs an instance set to the local time defined by the specified instant evaluated using ISO chronology in the specified zone.

If the specified time zone is null, the default zone is used. Once the constructor is completed, the zone is no longer used.

Parameters:
instant the milliseconds from 1970-01-01T00:00:00Z
zone the time zone, null means default zone
 
     public LocalTime(long instantDateTimeZone zone) {
         this(instant, ISOChronology.getInstance(zone));
     }

    
Constructs an instance set to the local time defined by the specified instant evaluated using the specified chronology.

If the chronology is null, ISO chronology in the default zone is used. Once the constructor is completed, the zone is no longer used.

Parameters:
instant the milliseconds from 1970-01-01T00:00:00Z
chronology the chronology, null means ISOChronology in default zone
 
     public LocalTime(long instantChronology chronology) {
         chronology = DateTimeUtils.getChronology(chronology);
         
         long localMillis = chronology.getZone().getMillisKeepLocal(.instant);
         chronology = chronology.withUTC();
          = chronology.millisOfDay().get(localMillis);
          = chronology;
     }
 
     //-----------------------------------------------------------------------
     
Constructs an instance from an Object that represents a datetime.

If the object contains no chronology, ISOChronology is used. If the object contains no time zone, the default zone is used. Once the constructor is completed, the zone is no longer used.

The recognised object types are defined in ConverterManager and include ReadablePartial, ReadableInstant, String, Calendar and Date. The String formats are described by ISODateTimeFormat.localTimeParser(). The default String converter ignores the zone and only parses the field values.

Parameters:
instant the datetime object
Throws:
IllegalArgumentException if the instant is invalid
 
     public LocalTime(Object instant) {
         this(instant, (Chronologynull);
     }

    
Constructs an instance from an Object that represents a datetime, forcing the time zone to that specified.

If the object contains no chronology, ISOChronology is used. If the specified time zone is null, the default zone is used. Once the constructor is completed, the zone is no longer used.

The recognised object types are defined in ConverterManager and include ReadablePartial, ReadableInstant, String, Calendar and Date. The String formats are described by ISODateTimeFormat.localTimeParser(). The default String converter ignores the zone and only parses the field values.

Parameters:
instant the datetime object
zone the time zone
Throws:
IllegalArgumentException if the instant is invalid
 
     public LocalTime(Object instantDateTimeZone zone) {
         PartialConverter converter = ConverterManager.getInstance().getPartialConverter(instant);
         Chronology chronology = converter.getChronology(instantzone);
         chronology = DateTimeUtils.getChronology(chronology);
          = chronology.withUTC();
         int[] values = converter.getPartialValues(thisinstantchronology, ISODateTimeFormat.localTimeParser());
          = .getDateTimeMillis(0L, values[0], values[1], values[2], values[3]);
     }

    
Constructs an instance from an Object that represents a datetime, using the specified chronology.

If the chronology is null, ISO in the default time zone is used. Once the constructor is completed, the zone is no longer used.

The recognised object types are defined in ConverterManager and include ReadablePartial, ReadableInstant, String, Calendar and Date. The String formats are described by ISODateTimeFormat.localTimeParser(). The default String converter ignores the zone and only parses the field values.

Parameters:
instant the datetime object
chronology the chronology
Throws:
IllegalArgumentException if the instant is invalid
 
     public LocalTime(Object instantChronology chronology) {
         PartialConverter converter = ConverterManager.getInstance().getPartialConverter(instant);
         chronology = converter.getChronology(instantchronology);
         chronology = DateTimeUtils.getChronology(chronology);
          = chronology.withUTC();
         int[] values = converter.getPartialValues(thisinstantchronology, ISODateTimeFormat.localTimeParser());
          = .getDateTimeMillis(0L, values[0], values[1], values[2], values[3]);
     }
 
     //-----------------------------------------------------------------------
     
Constructs an instance set to the specified time using ISOChronology.

Parameters:
hourOfDay the hour of the day
minuteOfHour the minute of the hour
 
     public LocalTime(
             int hourOfDay,
             int minuteOfHour) {
         this(hourOfDayminuteOfHour, 0, 0, ISOChronology.getInstanceUTC());
     }

    
Constructs an instance set to the specified time using ISOChronology.

Parameters:
hourOfDay the hour of the day
minuteOfHour the minute of the hour
secondOfMinute the second of the minute
 
     public LocalTime(
             int hourOfDay,
             int minuteOfHour,
             int secondOfMinute) {
         this(hourOfDayminuteOfHoursecondOfMinute, 0, ISOChronology.getInstanceUTC());
     }

    
Constructs an instance set to the specified time using ISOChronology.

Parameters:
hourOfDay the hour of the day
minuteOfHour the minute of the hour
secondOfMinute the second of the minute
millisOfSecond the millisecond of the second
 
     public LocalTime(
             int hourOfDay,
             int minuteOfHour,
             int secondOfMinute,
             int millisOfSecond) {
         this(hourOfDayminuteOfHoursecondOfMinute,
                 millisOfSecond, ISOChronology.getInstanceUTC());
     }

    
Constructs an instance set to the specified time using the specified chronology, whose zone is ignored.

If the chronology is null, ISOChronology is used.

Parameters:
hourOfDay the hour of the day
minuteOfHour the minute of the hour
secondOfMinute the second of the minute
millisOfSecond the millisecond of the second
chronology the chronology, null means ISOChronology in default zone
 
     public LocalTime(
             int hourOfDay,
             int minuteOfHour,
             int secondOfMinute,
             int millisOfSecond,
             Chronology chronology) {
         super();
         chronology = DateTimeUtils.getChronology(chronology).withUTC();
         long instant = chronology.getDateTimeMillis(
             0L, hourOfDayminuteOfHoursecondOfMinutemillisOfSecond);
          = chronology;
          = instant;
     }

    
Handle broken serialization from other tools.

Returns:
the resolved object, not null
 
     private Object readResolve() {
         if (..equals(.getZone()) == false) {
             return new LocalTime(.withUTC());
         }
         return this;
     }
 
     //-----------------------------------------------------------------------
     
Gets the number of fields in this partial, which is four. The supported fields are HourOfDay, MinuteOfHour, SecondOfMinute and MillisOfSecond.

Returns:
the field count, four
 
     public int size() {
         return 4;
     }

    
Gets the field for a specific index in the chronology specified.

This method must not use any instance variables.

Parameters:
index the index to retrieve
chrono the chronology to use
Returns:
the field
 
     protected DateTimeField getField(int indexChronology chrono) {
         switch (index) {
             case :
                 return chrono.hourOfDay();
             case :
                 return chrono.minuteOfHour();
             case :
                 return chrono.secondOfMinute();
             case :
                 return chrono.millisOfSecond();
             default:
                 throw new IndexOutOfBoundsException("Invalid index: " + index);
         }
     }

    
Gets the value of the field at the specifed index.

This method is required to support the ReadablePartial interface. The supported fields are HourOfDay, MinuteOfHour, SecondOfMinute and MillisOfSecond.

Parameters:
index the index, zero to three
Returns:
the value
Throws:
IndexOutOfBoundsException if the index is invalid
 
     public int getValue(int index) {
         switch (index) {
             case :
                 return getChronology().hourOfDay().get(getLocalMillis());
             case :
                 return getChronology().minuteOfHour().get(getLocalMillis());
             case :
                 return getChronology().secondOfMinute().get(getLocalMillis());
             case :
                 return getChronology().millisOfSecond().get(getLocalMillis());
             default:
                 throw new IndexOutOfBoundsException("Invalid index: " + index);
         }
     }
 
     //-----------------------------------------------------------------------
     
Get the value of one of the fields of time.

This method gets the value of the specified field. For example:

 DateTime dt = new DateTime();
 int hourOfDay = dt.get(DateTimeFieldType.hourOfDay());
 

Parameters:
fieldType a field type, usually obtained from DateTimeFieldType, not null
Returns:
the value of that field
Throws:
IllegalArgumentException if the field type is null
 
     public int get(DateTimeFieldType fieldType) {
         if (fieldType == null) {
             throw new IllegalArgumentException("The DateTimeFieldType must not be null");
         }
         if (isSupported(fieldType) == false) {
             throw new IllegalArgumentException("Field '" + fieldType + "' is not supported");
         }
         return fieldType.getField(getChronology()).get(getLocalMillis());
     }

    
Checks if the field type specified is supported by this local time and chronology. This can be used to avoid exceptions in get(DateTimeFieldType).

Parameters:
type a field type, usually obtained from DateTimeFieldType
Returns:
true if the field type is supported
 
     public boolean isSupported(DateTimeFieldType type) {
         if (type == null) {
             return false;
         }
         if (isSupported(type.getDurationType()) == false) {
             return false;
         }
         DurationFieldType range = type.getRangeDurationType();
         return (isSupported(range) || range == DurationFieldType.days());
     }

    
Checks if the duration type specified is supported by this local time and chronology.

Parameters:
type a duration type, usually obtained from DurationFieldType
Returns:
true if the field type is supported
 
     public boolean isSupported(DurationFieldType type) {
         if (type == null) {
             return false;
         }
         DurationField field = type.getField(getChronology());
         if (.contains(type) ||
             field.getUnitMillis() < getChronology().days().getUnitMillis()) {
             return field.isSupported();
         }
         return false;
     }
 
     //-----------------------------------------------------------------------
     
Gets the local milliseconds from the Java epoch of 1970-01-01T00:00:00 (not fixed to any specific time zone).

Returns:
the number of milliseconds since 1970-01-01T00:00:00
Since:
1.5 (previously private)
 
     protected long getLocalMillis() {
         return ;
     }

    
Gets the chronology of the time.

Returns:
the Chronology that the time is using
 
     public Chronology getChronology() {
         return ;
     }
 
     //-----------------------------------------------------------------------
     
Compares this ReadablePartial with another returning true if the chronology, field types and values are equal.

Parameters:
partial an object to check against
Returns:
true if fields and values are equal
 
     public boolean equals(Object partial) {
         // override to perform faster
         if (this == partial) {
             return true;
         }
         if (partial instanceof LocalTime) {
             LocalTime other = (LocalTimepartial;
             if (.equals(other.iChronology)) {
                 return  == other.iLocalMillis;
             }
         }
         return super.equals(partial);
     }

    
Compares this partial with another returning an integer indicating the order.

The fields are compared in order, from largest to smallest. The first field that is non-equal is used to determine the result.

The specified object must be a partial instance whose field types match those of this partial.

Parameters:
partial an object to check against
Returns:
negative if this is less, zero if equal, positive if greater
Throws:
ClassCastException if the partial is the wrong class or if it has field types that don't match
NullPointerException if the partial is null
 
     public int compareTo(ReadablePartial partial) {
         // override to perform faster
         if (this == partial) {
             return 0;
         }
         if (partial instanceof LocalTime) {
             LocalTime other = (LocalTimepartial;
             if (.equals(other.iChronology)) {
                 return ( < other.iLocalMillis ? -1 :
                             ( == other.iLocalMillis ? 0 : 1));
 
             }
         }
         return super.compareTo(partial);
     }
 
     //-----------------------------------------------------------------------
     
Returns a copy of this time with different local millis.

The returned object will be a new instance of the same type. Only the millis will change, the chronology is kept. The returned object will be either be a new instance or this.

Parameters:
newMillis the new millis, from 1970-01-01T00:00:00
Returns:
a copy of this time with different millis
 
     LocalTime withLocalMillis(long newMillis) {
         return (newMillis == getLocalMillis() ? this : new LocalTime(newMillisgetChronology()));
     }
 
     //-----------------------------------------------------------------------
     
Returns a copy of this time with the partial set of fields replacing those from this instance.

For example, if the partial contains an hour and minute then those two fields will be changed in the returned instance. Unsupported fields are ignored. If the partial is null, then this is returned.

Parameters:
partial the partial set of fields to apply to this time, null ignored
Returns:
a copy of this time with a different set of fields
Throws:
IllegalArgumentException if any value is invalid
 
     public LocalTime withFields(ReadablePartial partial) {
         if (partial == null) {
             return this;
         }
         return withLocalMillis(getChronology().set(partialgetLocalMillis()));
     }

    
Returns a copy of this time with the specified field set to a new value.

For example, if the field type is hourOfDay then the hour of day field would be changed in the returned instance. If the field type is null, then this is returned.

These lines are equivalent:

 LocalTime updated = dt.withHourOfDay(6);
 LocalTime updated = dt.withField(DateTimeFieldType.hourOfDay(), 6);
 

Parameters:
fieldType the field type to set, not null
value the value to set
Returns:
a copy of this time with the field set
Throws:
IllegalArgumentException if the value is null or invalid
 
     public LocalTime withField(DateTimeFieldType fieldTypeint value) {
         if (fieldType == null) {
             throw new IllegalArgumentException("Field must not be null");
         }
         if (isSupported(fieldType) == false) {
             throw new IllegalArgumentException("Field '" + fieldType + "' is not supported");
         }
         long instant = fieldType.getField(getChronology()).set(getLocalMillis(), value);
         return withLocalMillis(instant);
     }

    
Returns a copy of this time with the value of the specified field increased.

If the addition is zero or the field is null, then this is returned.

If the addition causes the maximum value of the field to be exceeded, then the value will wrap. Thus 23:59 plus two minutes yields 00:01.

These lines are equivalent:

 LocalTime added = dt.plusHours(6);
 LocalTime added = dt.withFieldAdded(DurationFieldType.hours(), 6);
 

Parameters:
fieldType the field type to add to, not null
amount the amount to add
Returns:
a copy of this time with the field updated
Throws:
IllegalArgumentException if the value is null or invalid
ArithmeticException if the result exceeds the internal capacity
 
     public LocalTime withFieldAdded(DurationFieldType fieldTypeint amount) {
         if (fieldType == null) {
             throw new IllegalArgumentException("Field must not be null");
         }
         if (isSupported(fieldType) == false) {
             throw new IllegalArgumentException("Field '" + fieldType + "' is not supported");
         }
         if (amount == 0) {
             return this;
         }
         long instant = fieldType.getField(getChronology()).add(getLocalMillis(), amount);
         return withLocalMillis(instant);
     }
 
     //-----------------------------------------------------------------------
     
Returns a copy of this time with the specified period added.

If the addition is zero, then this is returned.

This method is typically used to add multiple copies of complex period instances. Adding one field is best achieved using methods like withFieldAdded(DurationFieldType, int) or plusHours(int).

Parameters:
period the period to add to this one, null means zero
scalar the amount of times to add, such as -1 to subtract once
Returns:
a copy of this time with the period added
Throws:
ArithmeticException if the result exceeds the internal capacity
 
     public LocalTime withPeriodAdded(ReadablePeriod periodint scalar) {
         if (period == null || scalar == 0) {
             return this;
         }
         long instant = getChronology().add(periodgetLocalMillis(), scalar);
         return withLocalMillis(instant);
     }
 
     //-----------------------------------------------------------------------
     
Returns a copy of this time with the specified period added.

If the amount is zero or null, then this is returned.

This method is typically used to add complex period instances. Adding one field is best achieved using methods like plusHours(int).

Parameters:
period the period to add to this one, null means zero
Returns:
a copy of this time with the period added
Throws:
ArithmeticException if the result exceeds the internal capacity
 
     public LocalTime plus(ReadablePeriod period) {
         return withPeriodAdded(period, 1);
     }
 
     //-----------------------------------------------------------------------
     
Returns a copy of this time plus the specified number of hours.

This LocalTime instance is immutable and unaffected by this method call.

The following three lines are identical in effect:

 LocalTime added = dt.plusHours(6);
 LocalTime added = dt.plus(Period.hours(6));
 LocalTime added = dt.withFieldAdded(DurationFieldType.hours(), 6);
 

Parameters:
hours the amount of hours to add, may be negative
Returns:
the new LocalTime plus the increased hours
 
     public LocalTime plusHours(int hours) {
         if (hours == 0) {
             return this;
         }
         long instant = getChronology().hours().add(getLocalMillis(), hours);
         return withLocalMillis(instant);
     }

    
Returns a copy of this time plus the specified number of minutes.

This LocalTime instance is immutable and unaffected by this method call.

The following three lines are identical in effect:

 LocalTime added = dt.plusMinutes(6);
 LocalTime added = dt.plus(Period.minutes(6));
 LocalTime added = dt.withFieldAdded(DurationFieldType.minutes(), 6);
 

Parameters:
minutes the amount of minutes to add, may be negative
Returns:
the new LocalTime plus the increased minutes
 
     public LocalTime plusMinutes(int minutes) {
         if (minutes == 0) {
             return this;
         }
         long instant = getChronology().minutes().add(getLocalMillis(), minutes);
         return withLocalMillis(instant);
     }

    
Returns a copy of this time plus the specified number of seconds.

This LocalTime instance is immutable and unaffected by this method call.

The following three lines are identical in effect:

 LocalTime added = dt.plusSeconds(6);
 LocalTime added = dt.plus(Period.seconds(6));
 LocalTime added = dt.withFieldAdded(DurationFieldType.seconds(), 6);
 

Parameters:
seconds the amount of seconds to add, may be negative
Returns:
the new LocalTime plus the increased seconds
 
     public LocalTime plusSeconds(int seconds) {
         if (seconds == 0) {
             return this;
         }
         long instant = getChronology().seconds().add(getLocalMillis(), seconds);
         return withLocalMillis(instant);
     }

    
Returns a copy of this time plus the specified number of millis.

This LocalTime instance is immutable and unaffected by this method call.

The following three lines are identical in effect:

 LocalTime added = dt.plusMillis(6);
 LocalTime added = dt.plus(Period.millis(6));
 LocalTime added = dt.withFieldAdded(DurationFieldType.millis(), 6);
 

Parameters:
millis the amount of millis to add, may be negative
Returns:
the new LocalTime plus the increased millis
 
     public LocalTime plusMillis(int millis) {
         if (millis == 0) {
             return this;
         }
         long instant = getChronology().millis().add(getLocalMillis(), millis);
         return withLocalMillis(instant);
     }
 
     //-----------------------------------------------------------------------
     
Returns a copy of this time with the specified period taken away.

If the amount is zero or null, then this is returned.

This method is typically used to subtract complex period instances. Subtracting one field is best achieved using methods like minusHours(int).

Parameters:
period the period to reduce this instant by
Returns:
a copy of this time with the period taken away
Throws:
ArithmeticException if the result exceeds the internal capacity
 
     public LocalTime minus(ReadablePeriod period) {
         return withPeriodAdded(period, -1);
     }
 
     //-----------------------------------------------------------------------
     
Returns a copy of this time minus the specified number of hours.

This LocalTime instance is immutable and unaffected by this method call.

The following three lines are identical in effect:

 LocalTime subtracted = dt.minusHours(6);
 LocalTime subtracted = dt.minus(Period.hours(6));
 LocalTime subtracted = dt.withFieldAdded(DurationFieldType.hours(), -6);
 

Parameters:
hours the amount of hours to subtract, may be negative
Returns:
the new LocalTime minus the increased hours
 
     public LocalTime minusHours(int hours) {
         if (hours == 0) {
             return this;
         }
         long instant = getChronology().hours().subtract(getLocalMillis(), hours);
         return withLocalMillis(instant);
    }

    
Returns a copy of this time minus the specified number of minutes.

This LocalTime instance is immutable and unaffected by this method call.

The following three lines are identical in effect:

 LocalTime subtracted = dt.minusMinutes(6);
 LocalTime subtracted = dt.minus(Period.minutes(6));
 LocalTime subtracted = dt.withFieldAdded(DurationFieldType.minutes(), -6);
 

Parameters:
minutes the amount of minutes to subtract, may be negative
Returns:
the new LocalTime minus the increased minutes
    public LocalTime minusMinutes(int minutes) {
        if (minutes == 0) {
            return this;
        }
        long instant = getChronology().minutes().subtract(getLocalMillis(), minutes);
        return withLocalMillis(instant);
    }

    
Returns a copy of this time minus the specified number of seconds.

This LocalTime instance is immutable and unaffected by this method call.

The following three lines are identical in effect:

 LocalTime subtracted = dt.minusSeconds(6);
 LocalTime subtracted = dt.minus(Period.seconds(6));
 LocalTime subtracted = dt.withFieldAdded(DurationFieldType.seconds(), -6);
 

Parameters:
seconds the amount of seconds to subtract, may be negative
Returns:
the new LocalTime minus the increased seconds
    public LocalTime minusSeconds(int seconds) {
        if (seconds == 0) {
            return this;
        }
        long instant = getChronology().seconds().subtract(getLocalMillis(), seconds);
        return withLocalMillis(instant);
    }

    
Returns a copy of this time minus the specified number of millis.

This LocalTime instance is immutable and unaffected by this method call.

The following three lines are identical in effect:

 LocalTime subtracted = dt.minusMillis(6);
 LocalTime subtracted = dt.minus(Period.millis(6));
 LocalTime subtracted = dt.withFieldAdded(DurationFieldType.millis(), -6);
 

Parameters:
millis the amount of millis to subtract, may be negative
Returns:
the new LocalTime minus the increased millis
    public LocalTime minusMillis(int millis) {
        if (millis == 0) {
            return this;
        }
        long instant = getChronology().millis().subtract(getLocalMillis(), millis);
        return withLocalMillis(instant);
    }
    //-----------------------------------------------------------------------
    
Gets the property object for the specified type, which contains many useful methods.

Parameters:
fieldType the field type to get the chronology for
Returns:
the property object
Throws:
IllegalArgumentException if the field is null or unsupported
    public Property property(DateTimeFieldType fieldType) {
        if (fieldType == null) {
            throw new IllegalArgumentException("The DateTimeFieldType must not be null");
        }
        if (isSupported(fieldType) == false) {
            throw new IllegalArgumentException("Field '" + fieldType + "' is not supported");
        }
        return new Property(thisfieldType.getField(getChronology()));
    }
    //-----------------------------------------------------------------------
    
Get the hour of day field value.

Returns:
the hour of day
    public int getHourOfDay() {
        return getChronology().hourOfDay().get(getLocalMillis());
    }

    
Get the minute of hour field value.

Returns:
the minute of hour
    public int getMinuteOfHour() {
        return getChronology().minuteOfHour().get(getLocalMillis());
    }

    
Get the second of minute field value.

Returns:
the second of minute
    public int getSecondOfMinute() {
        return getChronology().secondOfMinute().get(getLocalMillis());
    }

    
Get the millis of second field value.

Returns:
the millis of second
    public int getMillisOfSecond() {
        return getChronology().millisOfSecond().get(getLocalMillis());
    }

    
Get the millis of day field value.

Returns:
the millis of day
    public int getMillisOfDay() {
        return getChronology().millisOfDay().get(getLocalMillis());
    }
    //-----------------------------------------------------------------------
    
Returns a copy of this time with the hour of day field updated.

LocalTime is immutable, so there are no set methods. Instead, this method returns a new instance with the value of hour of day changed.

Parameters:
hour the hour of day to set
Returns:
a copy of this object with the field set
Throws:
IllegalArgumentException if the value is invalid
    public LocalTime withHourOfDay(int hour) {
        return withLocalMillis(getChronology().hourOfDay().set(getLocalMillis(), hour));
    }

    
Returns a copy of this time with the minute of hour field updated.

LocalTime is immutable, so there are no set methods. Instead, this method returns a new instance with the value of minute of hour changed.

Parameters:
minute the minute of hour to set
Returns:
a copy of this object with the field set
Throws:
IllegalArgumentException if the value is invalid
    public LocalTime withMinuteOfHour(int minute) {
        return withLocalMillis(getChronology().minuteOfHour().set(getLocalMillis(), minute));
    }

    
Returns a copy of this time with the second of minute field updated.

LocalTime is immutable, so there are no set methods. Instead, this method returns a new instance with the value of second of minute changed.

Parameters:
second the second of minute to set
Returns:
a copy of this object with the field set
Throws:
IllegalArgumentException if the value is invalid
    public LocalTime withSecondOfMinute(int second) {
        return withLocalMillis(getChronology().secondOfMinute().set(getLocalMillis(), second));
    }

    
Returns a copy of this time with the millis of second field updated.

LocalTime is immutable, so there are no set methods. Instead, this method returns a new instance with the value of millis of second changed.

Parameters:
millis the millis of second to set
Returns:
a copy of this object with the field set
Throws:
IllegalArgumentException if the value is invalid
    public LocalTime withMillisOfSecond(int millis) {
        return withLocalMillis(getChronology().millisOfSecond().set(getLocalMillis(), millis));
    }

    
Returns a copy of this time with the millis of day field updated.

LocalTime is immutable, so there are no set methods. Instead, this method returns a new instance with the value of millis of day changed.

Parameters:
millis the millis of day to set
Returns:
a copy of this object with the field set
Throws:
IllegalArgumentException if the value is invalid
    public LocalTime withMillisOfDay(int millis) {
        return withLocalMillis(getChronology().millisOfDay().set(getLocalMillis(), millis));
    }
    //-----------------------------------------------------------------------
    
Get the hour of day field property which provides access to advanced functionality.

Returns:
the hour of day property
    public Property hourOfDay() {
        return new Property(thisgetChronology().hourOfDay());
    }

    
Get the minute of hour field property which provides access to advanced functionality.

Returns:
the minute of hour property
    public Property minuteOfHour() {
        return new Property(thisgetChronology().minuteOfHour());
    }

    
Get the second of minute field property which provides access to advanced functionality.

Returns:
the second of minute property
    public Property secondOfMinute() {
        return new Property(thisgetChronology().secondOfMinute());
    }

    
Get the millis of second property which provides access to advanced functionality.

Returns:
the millis of second property
    public Property millisOfSecond() {
        return new Property(thisgetChronology().millisOfSecond());
    }

    
Get the millis of day property which provides access to advanced functionality.

Returns:
the millis of day property
    public Property millisOfDay() {
        return new Property(thisgetChronology().millisOfDay());
    }
    //-----------------------------------------------------------------------
    
Converts this LocalTime to a full datetime using the default time zone setting the time fields from this instance and the date fields from the current date.

Returns:
this time as a datetime using todays date
    public DateTime toDateTimeToday() {
        return toDateTimeToday(null);
    }

    
Converts this LocalTime to a full datetime using the specified time zone setting the time fields from this instance and the date fields from the current time.

This method uses the chronology from this instance plus the time zone specified.

Parameters:
zone the zone to use, null means default
Returns:
this time as a datetime using todays date
    public DateTime toDateTimeToday(DateTimeZone zone) {
        Chronology chrono = getChronology().withZone(zone);
        long instantMillis = DateTimeUtils.currentTimeMillis();
        long resolved = chrono.set(thisinstantMillis);
        return new DateTime(resolvedchrono);
    }
    //-----------------------------------------------------------------------
    
Output the time in ISO8601 format (HH:mm:ss.SSSZZ).

Returns:
ISO8601 time formatted string.
    @ToString
    public String toString() {
        return ISODateTimeFormat.time().print(this);
    }

    
Output the time using the specified format pattern.

Parameters:
pattern the pattern specification, null means use toString
See also:
org.joda.time.format.DateTimeFormat
    public String toString(String pattern) {
        if (pattern == null) {
            return toString();
        }
        return DateTimeFormat.forPattern(pattern).print(this);
    }

    
Output the time using the specified format pattern.

Parameters:
pattern the pattern specification, null means use toString
locale Locale to use, null means default
See also:
org.joda.time.format.DateTimeFormat
    public String toString(String patternLocale localethrows IllegalArgumentException {
        if (pattern == null) {
            return toString();
        }
        return DateTimeFormat.forPattern(pattern).withLocale(locale).print(this);
    }
    //-----------------------------------------------------------------------
    
LocalTime.Property binds a LocalTime 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 minute '30'.

 LocalTime dt = new LocalTime(12, 30);
 int year = dt.minuteOfHour().get();
 

Methods are also provided that allow time modification. These return new instances of LocalTime - they do not modify the original. The example below yields two independent immutable date objects 2 hours apart.

 LocalTime dt1230 = new LocalTime(12, 30);
 LocalTime dt1430 = dt1230.hourOfDay().setCopy(14);
 

LocalTime.Property itself is thread-safe and immutable, as well as the LocalTime being operated on.

Author(s):
Stephen Colebourne
Brian S O'Neill
Since:
1.3
    public static final class Property extends AbstractReadableInstantFieldProperty {
        
        
Serialization version
        private static final long serialVersionUID = -325842547277223L;
        
        
The instant this property is working against
        private transient LocalTime iInstant;
        
The field this property is working against
        private transient DateTimeField iField;
        
        
Constructor.

Parameters:
instant the instant to set
field the field to use
        Property(LocalTime instantDateTimeField field) {
            super();
             = instant;
             = field;
        }
        
        
Writes the property in a safe serialization format.
        private void writeObject(ObjectOutputStream oosthrows IOException {
            oos.writeObject();
            oos.writeObject(.getType());
        }
        
        
Reads the property from a safe serialization format.
        private void readObject(ObjectInputStream oosthrows IOExceptionClassNotFoundException {
             = (LocalTimeoos.readObject();
            DateTimeFieldType type = (DateTimeFieldTypeoos.readObject();
             = type.getField(.getChronology());
        }
        
        //-----------------------------------------------------------------------
        
Gets the field being used.

Returns:
the field
        public DateTimeField getField() {
            return ;
        }
        
        
Gets the milliseconds of the time that this property is linked to.

Returns:
the milliseconds
        protected long getMillis() {
            return .getLocalMillis();
        }
        
        
Gets the chronology of the datetime that this property is linked to.

Returns:
the chronology
Since:
1.4
        protected Chronology getChronology() {
            return .getChronology();
        }
        
        
Gets the LocalTime object linked to this property.

Returns:
the linked LocalTime
        public LocalTime getLocalTime() {
            return ;
        }
        
        //-----------------------------------------------------------------------
        
Adds to this field in a copy of this LocalTime.

The LocalTime attached to this property is unchanged by this call.

Parameters:
value the value to add to the field in the copy
Returns:
a copy of the LocalTime with the field value changed
        public LocalTime addCopy(int value) {
            return .withLocalMillis(.add(.getLocalMillis(), value));
        }
        
        
Adds to this field in a copy of this LocalTime. If the addition exceeds the maximum value (eg. 23:59) it will wrap to the minimum value (eg. 00:00).

The LocalTime attached to this property is unchanged by this call.

Parameters:
value the value to add to the field in the copy
Returns:
a copy of the LocalTime with the field value changed
        public LocalTime addCopy(long value) {
            return .withLocalMillis(.add(.getLocalMillis(), value));
        }
        
        
Adds to this field in a copy of this LocalTime. If the addition exceeds the maximum value (eg. 23:59) then an exception will be thrown. Contrast this behaviour to addCopy(int).

The LocalTime attached to this property is unchanged by this call.

Parameters:
value the value to add to the field in the copy
Returns:
a copy of the LocalTime with the field value changed
Throws:
IllegalArgumentException if the result is invalid
        public LocalTime addNoWrapToCopy(int value) {
            long millis = .add(.getLocalMillis(), value);
            long rounded = .getChronology().millisOfDay().get(millis);
            if (rounded != millis) {
                throw new IllegalArgumentException("The addition exceeded the boundaries of LocalTime");
            }
            return .withLocalMillis(millis);
        }
        
        
Adds to this field, possibly wrapped, in a copy of this LocalTime. A field wrapped operation only changes this field. Thus 10:59 plusWrapField one minute goes to 10:00.

The LocalTime attached to this property is unchanged by this call.

Parameters:
value the value to add to the field in the copy
Returns:
a copy of the LocalTime with the field value changed
Throws:
IllegalArgumentException if the value isn't valid
        public LocalTime addWrapFieldToCopy(int value) {
            return .withLocalMillis(.addWrapField(.getLocalMillis(), value));
        }
        
        //-----------------------------------------------------------------------
        
Sets this field in a copy of the LocalTime.

The LocalTime attached to this property is unchanged by this call.

Parameters:
value the value to set the field in the copy to
Returns:
a copy of the LocalTime with the field value changed
Throws:
IllegalArgumentException if the value isn't valid
        public LocalTime setCopy(int value) {
            return .withLocalMillis(.set(.getLocalMillis(), value));
        }
        
        
Sets this field in a copy of the LocalTime to a parsed text value.

The LocalTime attached to this property is unchanged by this call.

Parameters:
text the text value to set
locale optional locale to use for selecting a text symbol
Returns:
a copy of the LocalTime with the field value changed
Throws:
IllegalArgumentException if the text value isn't valid
        public LocalTime setCopy(String textLocale locale) {
            return .withLocalMillis(.set(.getLocalMillis(), textlocale));
        }
        
        
Sets this field in a copy of the LocalTime to a parsed text value.

The LocalTime attached to this property is unchanged by this call.

Parameters:
text the text value to set
Returns:
a copy of the LocalTime with the field value changed
Throws:
IllegalArgumentException if the text value isn't valid
        public LocalTime setCopy(String text) {
            return setCopy(textnull);
        }
        
        //-----------------------------------------------------------------------
        
Returns a new LocalTime with this field set to the maximum value for this field.

The LocalTime attached to this property is unchanged by this call.

Returns:
a copy of the LocalTime with this field set to its maximum
        public LocalTime withMaximumValue() {
            return setCopy(getMaximumValue());
        }
        
        
Returns a new LocalTime with this field set to the minimum value for this field.

The LocalTime attached to this property is unchanged by this call.

Returns:
a copy of the LocalTime with this field set to its minimum
        public LocalTime withMinimumValue() {
            return setCopy(getMinimumValue());
        }
        
        //-----------------------------------------------------------------------
        
Rounds to the lowest whole unit of this field on a copy of this LocalTime.

For example, rounding floor on the hourOfDay field of a LocalTime where the time is 10:30 would result in new LocalTime with the time of 10:00.

Returns:
a copy of the LocalTime with the field value changed
        public LocalTime roundFloorCopy() {
        }
        
        
Rounds to the highest whole unit of this field on a copy of this LocalTime.

For example, rounding floor on the hourOfDay field of a LocalTime where the time is 10:30 would result in new LocalTime with the time of 11:00.

Returns:
a copy of the LocalTime with the field value changed
        public LocalTime roundCeilingCopy() {
        }
        
        
Rounds to the nearest whole unit of this field on a copy of this LocalTime, favoring the floor if halfway.

Returns:
a copy of the LocalTime with the field value changed
        public LocalTime roundHalfFloorCopy() {
        }
        
        
Rounds to the nearest whole unit of this field on a copy of this LocalTime, favoring the ceiling if halfway.

Returns:
a copy of the LocalTime with the field value changed
        public LocalTime roundHalfCeilingCopy() {
        }
        
        
Rounds to the nearest whole unit of this field on a copy of this LocalTime. If halfway, the ceiling is favored over the floor only if it makes this field's value even.

Returns:
a copy of the LocalTime with the field value changed
        public LocalTime roundHalfEvenCopy() {
        }
    }
New to GrepCode? Check out our FAQ X