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 an instant in the datetime continuum that can be queried and modified. This interface expresses the datetime as milliseconds from 1970-01-01T00:00:00Z.

The implementation of this interface will be mutable. It may provide more advanced methods than those in the interface.

Author(s):
Stephen Colebourne
Since:
1.0
 
 public interface ReadWritableInstant extends ReadableInstant {

    
Sets the value as the number of milliseconds since the epoch, 1970-01-01T00:00:00Z.

Parameters:
instant the milliseconds since 1970-01-01T00:00:00Z to set the instant to
Throws:
java.lang.IllegalArgumentException if the value is invalid
 
     void setMillis(long instant);

    
Sets the millisecond instant of this instant from another.

This method does not change the chronology of this instant, just the millisecond instant.

Parameters:
instant the instant to use, null means now
 
     void setMillis(ReadableInstant instant);

    
Sets the chronology of the datetime, which has no effect if not applicable.

Parameters:
chronology the chronology to use, null means ISOChronology in default zone
Throws:
java.lang.IllegalArgumentException if the value is invalid
 
     void setChronology(Chronology chronology);

    
Sets the time zone of the datetime, changing the chronology and field values.

Changing the zone using this method retains the millisecond instant. The millisecond instant is adjusted in the new zone to compensate. chronology. Setting the time zone does not affect the millisecond value of this instant.

If the chronology already has this time zone, no change occurs.

Parameters:
zone the time zone to use, null means default zone
See also:
setZoneRetainFields(org.joda.time.DateTimeZone)
 
     void setZone(DateTimeZone zone);

    
Sets the time zone of the datetime, changing the chronology and millisecond.

Changing the zone using this method retains the field values. The millisecond instant is adjusted in the new zone to compensate.

If the chronology already has this time zone, no change occurs.

Parameters:
zone the time zone to use, null means default zone
See also:
setZone(org.joda.time.DateTimeZone)
 
     void setZoneRetainFields(DateTimeZone zone);
 
     //-----------------------------------------------------------------------
     
Adds a millisecond duration to this instant.

This will typically change the value of ost fields.

Parameters:
duration the millis to add
Throws:
java.lang.IllegalArgumentException if the value is invalid
 
     void add(long duration);

    
Adds a duration to this instant.

This will typically change the value of most fields.

Parameters:
duration the duration to add, null means add zero
Throws:
java.lang.ArithmeticException if the result exceeds the capacity of the instant
    void add(ReadableDuration duration);

    
Adds a duration to this instant specifying how many times to add.

This will typically change the value of most fields.

Parameters:
duration the duration to add, null means add zero
scalar direction and amount to add, which may be negative
Throws:
java.lang.ArithmeticException if the result exceeds the capacity of the instant
    void add(ReadableDuration durationint scalar);

    
Adds a period to this instant.

This will typically change the value of most fields.

Parameters:
period the period to add, null means add zero
Throws:
java.lang.ArithmeticException if the result exceeds the capacity of the instant
    void add(ReadablePeriod period);

    
Adds a period to this instant specifying how many times to add.

This will typically change the value of most fields.

Parameters:
period the period to add, null means add zero
scalar direction and amount to add, which may be negative
Throws:
java.lang.ArithmeticException if the result exceeds the capacity of the instant
    void add(ReadablePeriod periodint scalar);
    //-----------------------------------------------------------------------
    
Sets the value of one of the fields of the instant, such as hourOfDay.

Parameters:
type a field type, usually obtained from DateTimeFieldType, null ignored
value the value to set the field to
Throws:
java.lang.IllegalArgumentException if the value is invalid
    void set(DateTimeFieldType typeint value);

    
Adds to the instant specifying the duration and multiple to add.

Parameters:
type a field type, usually obtained from DateTimeFieldType, null ignored
amount the amount to add of this duration
Throws:
java.lang.ArithmeticException if the result exceeds the capacity of the instant
    void add(DurationFieldType typeint amount);
New to GrepCode? Check out our FAQ X