Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   *  Copyright 2001-2006 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;
 
An immutable time period representing a number of seconds.

Seconds is an immutable period that can only store seconds. It does not store years, months or hours for example. As such it is a type-safe way of representing a number of seconds in an application.

The number of seconds is set in the constructor, and may be queried using getSeconds(). Basic mathematical operations are provided - plus(), minus(), multipliedBy() and dividedBy().

Seconds is thread-safe and immutable.

Author(s):
Stephen Colebourne
Since:
1.4
 
 public final class Seconds extends BaseSingleFieldPeriod {

    
Constant representing zero seconds.
 
     public static final Seconds ZERO = new Seconds(0);
    
Constant representing one second.
 
     public static final Seconds ONE = new Seconds(1);
    
Constant representing two seconds.
 
     public static final Seconds TWO = new Seconds(2);
    
Constant representing three seconds.
 
     public static final Seconds THREE = new Seconds(3);
    
Constant representing the maximum number of seconds that can be stored in this object.
 
     public static final Seconds MAX_VALUE = new Seconds(.);
    
Constant representing the minimum number of seconds that can be stored in this object.
 
     public static final Seconds MIN_VALUE = new Seconds(.);

    
The paser to use for this class.
 
     private static final PeriodFormatter PARSER = ISOPeriodFormat.standard().withParseType(PeriodType.seconds());
    
Serialization version.
 
     private static final long serialVersionUID = 87525275727380862L;
 
     //-----------------------------------------------------------------------
     
Obtains an instance of Seconds that may be cached. Seconds is immutable, so instances can be cached and shared. This factory method provides access to shared instances.

Parameters:
seconds the number of seconds to obtain an instance for
Returns:
the instance of Seconds
 
     public static Seconds seconds(int seconds) {
         switch (seconds) {
             case 0:
                 return ;
             case 1:
                 return ;
             case 2:
                 return ;
             case 3:
                 return ;
             case .:
                 return ;
             case .:
                 return ;
             default:
                 return new Seconds(seconds);
         }
     }
 
     //-----------------------------------------------------------------------
     
Creates a Seconds representing the number of whole seconds between the two specified datetimes.

Parameters:
start the start instant, must not be null
end the end instant, must not be null
Returns:
the period in seconds
Throws:
java.lang.IllegalArgumentException if the instants are null or invalid
 
     public static Seconds secondsBetween(ReadableInstant startReadableInstant end) {
         int amount = BaseSingleFieldPeriod.between(startend, DurationFieldType.seconds());
        return Seconds.seconds(amount);
    }

    
Creates a Seconds representing the number of whole seconds between the two specified partial datetimes.

The two partials must contain the same fields, for example you can specify two LocalTime objects.

Parameters:
start the start partial date, must not be null
end the end partial date, must not be null
Returns:
the period in seconds
Throws:
java.lang.IllegalArgumentException if the partials are null or invalid
    public static Seconds secondsBetween(ReadablePartial startReadablePartial end) {
        if (start instanceof LocalTime && end instanceof LocalTime)   {
            Chronology chrono = DateTimeUtils.getChronology(start.getChronology());
            int seconds = chrono.seconds().getDifference(
                    ((LocalTimeend).getLocalMillis(), ((LocalTimestart).getLocalMillis());
            return Seconds.seconds(seconds);
        }
        int amount = BaseSingleFieldPeriod.between(startend);
        return Seconds.seconds(amount);
    }

    
Creates a Seconds representing the number of whole seconds in the specified interval.

Parameters:
interval the interval to extract seconds from, null returns zero
Returns:
the period in seconds
Throws:
java.lang.IllegalArgumentException if the partials are null or invalid
    public static Seconds secondsIn(ReadableInterval interval) {
        if (interval == null)   {
            return .;
        }
        int amount = BaseSingleFieldPeriod.between(interval.getStart(), interval.getEnd(), DurationFieldType.seconds());
        return Seconds.seconds(amount);
    }

    
Creates a new Seconds representing the number of complete standard length seconds in the specified period.

This factory method converts all fields from the period to hours using standardised durations for each field. Only those fields which have a precise duration in the ISO UTC chronology can be converted.

  • One week consists of 7 seconds.
  • One day consists of 24 hours.
  • One hour consists of 60 minutes.
  • One minute consists of 60 seconds.
  • One second consists of 1000 milliseconds.
Months and Years are imprecise and periods containing these values cannot be converted.

Parameters:
period the period to get the number of hours from, null returns zero
Returns:
the period in seconds
Throws:
java.lang.IllegalArgumentException if the period contains imprecise duration values
    public static Seconds standardSecondsIn(ReadablePeriod period) {
        int amount = BaseSingleFieldPeriod.standardPeriodIn(period.);
        return Seconds.seconds(amount);
    }

    
Creates a new Seconds by parsing a string in the ISO8601 format 'PTnS'.

The parse will accept the full ISO syntax of PnYnMnWnDTnHnMnS however only the seconds component may be non-zero. If any other component is non-zero, an exception will be thrown.

Parameters:
periodStr the period string, null returns zero
Returns:
the period in seconds
Throws:
java.lang.IllegalArgumentException if the string format is invalid
    public static Seconds parseSeconds(String periodStr) {
        if (periodStr == null) {
            return .;
        }
        Period p = .parsePeriod(periodStr);
        return Seconds.seconds(p.getSeconds());
    }
    //-----------------------------------------------------------------------
    
Creates a new instance representing a number of seconds. You should consider using the factory method seconds(int) instead of the constructor.

Parameters:
seconds the number of seconds to represent
    private Seconds(int seconds) {
        super(seconds);
    }

    
Resolves singletons.

Returns:
the singleton instance
    private Object readResolve() {
        return Seconds.seconds(getValue());
    }
    //-----------------------------------------------------------------------
    
Gets the duration field type, which is seconds.

Returns:
the period type
    public DurationFieldType getFieldType() {
        return DurationFieldType.seconds();
    }

    
Gets the period type, which is seconds.

Returns:
the period type
    public PeriodType getPeriodType() {
        return PeriodType.seconds();
    }
    //-----------------------------------------------------------------------
    
Converts this period in seconds to a period in weeks assuming a 7 day week, 24 hour day, 60 minute hour and 60 second minute.

This method allows you to convert between different types of period. However to achieve this it makes the assumption that all weeks are 7 days long, all days are 24 hours long, all hours are 60 minutes long and all minutes are 60 seconds long. This is not true when daylight savings time is considered, and may also not be true for some unusual chronologies. However, it is included as it is a useful operation for many applications and business rules.

Returns:
a period representing the number of whole weeks for this number of seconds
    public Weeks toStandardWeeks() {
        return Weeks.weeks(getValue() / .);
    }

    
Converts this period in seconds to a period in days assuming a 24 hour day, 60 minute hour and 60 second minute.

This method allows you to convert between different types of period. However to achieve this it makes the assumption that all days are 24 hours long, all hours are 60 minutes long and all minutes are 60 seconds long. This is not true when daylight savings is considered and may also not be true for some unusual chronologies. However, it is included as it is a useful operation for many applications and business rules.

Returns:
a period representing the number of days for this number of seconds
    public Days toStandardDays() {
        return Days.days(getValue() / .);
    }

    
Converts this period in seconds to a period in hours assuming a 60 minute hour and 60 second minute.

This method allows you to convert between different types of period. However to achieve this it makes the assumption that all hours are 60 minutes long and all minutes are 60 seconds long. This may not be true for some unusual chronologies. However, it is included as it is a useful operation for many applications and business rules.

Returns:
a period representing the number of hours for this number of seconds
    public Hours toStandardHours() {
        return Hours.hours(getValue() / .);
    }

    
Converts this period in seconds to a period in minutes assuming a 60 second minute.

This method allows you to convert between different types of period. However to achieve this it makes the assumption that all minutes are 60 seconds long. This may not be true for some unusual chronologies. However, it is included as it is a useful operation for many applications and business rules.

Returns:
a period representing the number of minutes for this number of seconds
    public Minutes toStandardMinutes() {
        return Minutes.minutes(getValue() / .);
    }
    //-----------------------------------------------------------------------
    
Converts this period in seconds to a duration in milliseconds assuming a 24 hour day, 60 minute hour and 60 second minute.

This method allows you to convert from a period to a duration. However to achieve this it makes the assumption that all seconds are 24 hours long, all hours are 60 minutes and all minutes are 60 seconds. This is not true when daylight savings time is considered, and may also not be true for some unusual chronologies. However, it is included as it is a useful operation for many applications and business rules.

Returns:
a duration equivalent to this number of seconds
    public Duration toStandardDuration() {
        long seconds = getValue();  // assign to a long
        return new Duration(seconds * .);
    }
    //-----------------------------------------------------------------------
    
Gets the number of seconds that this period represents.

Returns:
the number of seconds in the period
    public int getSeconds() {
        return getValue();
    }
    //-----------------------------------------------------------------------
    
Returns a new instance with the specified number of seconds added.

This instance is immutable and unaffected by this method call.

Parameters:
seconds the amount of seconds to add, may be negative
Returns:
the new period plus the specified number of seconds
Throws:
java.lang.ArithmeticException if the result overflows an int
    public Seconds plus(int seconds) {
        if (seconds == 0) {
            return this;
        }
        return Seconds.seconds(FieldUtils.safeAdd(getValue(), seconds));
    }

    
Returns a new instance with the specified number of seconds added.

This instance is immutable and unaffected by this method call.

Parameters:
seconds the amount of seconds to add, may be negative, null means zero
Returns:
the new period plus the specified number of seconds
Throws:
java.lang.ArithmeticException if the result overflows an int
    public Seconds plus(Seconds seconds) {
        if (seconds == null) {
            return this;
        }
        return plus(seconds.getValue());
    }
    //-----------------------------------------------------------------------
    
Returns a new instance with the specified number of seconds taken away.

This instance is immutable and unaffected by this method call.

Parameters:
seconds the amount of seconds to take away, may be negative
Returns:
the new period minus the specified number of seconds
Throws:
java.lang.ArithmeticException if the result overflows an int
    public Seconds minus(int seconds) {
        return plus(FieldUtils.safeNegate(seconds));
    }

    
Returns a new instance with the specified number of seconds taken away.

This instance is immutable and unaffected by this method call.

Parameters:
seconds the amount of seconds to take away, may be negative, null means zero
Returns:
the new period minus the specified number of seconds
Throws:
java.lang.ArithmeticException if the result overflows an int
    public Seconds minus(Seconds seconds) {
        if (seconds == null) {
            return this;
        }
        return minus(seconds.getValue());
    }
    //-----------------------------------------------------------------------
    
Returns a new instance with the seconds multiplied by the specified scalar.

This instance is immutable and unaffected by this method call.

Parameters:
scalar the amount to multiply by, may be negative
Returns:
the new period multiplied by the specified scalar
Throws:
java.lang.ArithmeticException if the result overflows an int
    public Seconds multipliedBy(int scalar) {
        return Seconds.seconds(FieldUtils.safeMultiply(getValue(), scalar));
    }

    
Returns a new instance with the seconds divided by the specified divisor. The calculation uses integer division, thus 3 divided by 2 is 1.

This instance is immutable and unaffected by this method call.

Parameters:
divisor the amount to divide by, may be negative
Returns:
the new period divided by the specified divisor
Throws:
java.lang.ArithmeticException if the divisor is zero
    public Seconds dividedBy(int divisor) {
        if (divisor == 1) {
            return this;
        }
        return Seconds.seconds(getValue() / divisor);
    }
    //-----------------------------------------------------------------------
    
Returns a new instance with the seconds value negated.

Returns:
the new period with a negated value
Throws:
java.lang.ArithmeticException if the result overflows an int
    public Seconds negated() {
        return Seconds.seconds(FieldUtils.safeNegate(getValue()));
    }
    //-----------------------------------------------------------------------
    
Is this seconds instance greater than the specified number of seconds.

Parameters:
other the other period, null means zero
Returns:
true if this seconds instance is greater than the specified one
    public boolean isGreaterThan(Seconds other) {
        if (other == null) {
            return getValue() > 0;
        }
        return getValue() > other.getValue();
    }

    
Is this seconds instance less than the specified number of seconds.

Parameters:
other the other period, null means zero
Returns:
true if this seconds instance is less than the specified one
    public boolean isLessThan(Seconds other) {
        if (other == null) {
            return getValue() < 0;
        }
        return getValue() < other.getValue();
    }
    //-----------------------------------------------------------------------
    
Gets this instance as a String in the ISO8601 duration format.

For example, "PT4S" represents 4 seconds.

Returns:
the value as an ISO8601 string
    public String toString() {
        return "PT" + String.valueOf(getValue()) + "S";
    }
New to GrepCode? Check out our FAQ X