Class Seconds
 java.lang.Object

 org.joda.time.base.BaseSingleFieldPeriod

 org.joda.time.Seconds

 All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<BaseSingleFieldPeriod>
,ReadablePeriod
public final class Seconds extends BaseSingleFieldPeriod
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 typesafe 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()
anddividedBy()
.Seconds
is threadsafe and immutable. Since:
 1.4
 See Also:
 Serialized Form


Field Summary
Fields Modifier and Type Field Description static Seconds
MAX_VALUE
Constant representing the maximum number of seconds that can be stored in this object.static Seconds
MIN_VALUE
Constant representing the minimum number of seconds that can be stored in this object.static Seconds
ONE
Constant representing one second.static Seconds
THREE
Constant representing three seconds.static Seconds
TWO
Constant representing two seconds.static Seconds
ZERO
Constant representing zero seconds.

Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Seconds
dividedBy(int divisor)
Returns a new instance with the seconds divided by the specified divisor.DurationFieldType
getFieldType()
Gets the duration field type, which isseconds
.PeriodType
getPeriodType()
Gets the period type, which isseconds
.int
getSeconds()
Gets the number of seconds that this period represents.boolean
isGreaterThan(Seconds other)
Is this seconds instance greater than the specified number of seconds.boolean
isLessThan(Seconds other)
Is this seconds instance less than the specified number of seconds.Seconds
minus(int seconds)
Returns a new instance with the specified number of seconds taken away.Seconds
minus(Seconds seconds)
Returns a new instance with the specified number of seconds taken away.Seconds
multipliedBy(int scalar)
Returns a new instance with the seconds multiplied by the specified scalar.Seconds
negated()
Returns a new instance with the seconds value negated.static Seconds
parseSeconds(java.lang.String periodStr)
Creates a newSeconds
by parsing a string in the ISO8601 format 'PTnS'.Seconds
plus(int seconds)
Returns a new instance with the specified number of seconds added.Seconds
plus(Seconds seconds)
Returns a new instance with the specified number of seconds added.static Seconds
seconds(int seconds)
Obtains an instance ofSeconds
that may be cached.static Seconds
secondsBetween(ReadableInstant start, ReadableInstant end)
Creates aSeconds
representing the number of whole seconds between the two specified datetimes.static Seconds
secondsBetween(ReadablePartial start, ReadablePartial end)
Creates aSeconds
representing the number of whole seconds between the two specified partial datetimes.static Seconds
secondsIn(ReadableInterval interval)
Creates aSeconds
representing the number of whole seconds in the specified interval.static Seconds
standardSecondsIn(ReadablePeriod period)
Creates a newSeconds
representing the number of complete standard length seconds in the specified period.Days
toStandardDays()
Converts this period in seconds to a period in days assuming a 24 hour day, 60 minute hour and 60 second minute.Duration
toStandardDuration()
Converts this period in seconds to a duration in milliseconds assuming a 24 hour day, 60 minute hour and 60 second minute.Hours
toStandardHours()
Converts this period in seconds to a period in hours assuming a 60 minute hour and 60 second minute.Minutes
toStandardMinutes()
Converts this period in seconds to a period in minutes assuming a 60 second minute.Weeks
toStandardWeeks()
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.java.lang.String
toString()
Gets this instance as a String in the ISO8601 duration format.
Methods inherited from class org.joda.time.base.BaseSingleFieldPeriod
compareTo, equals, get, getFieldType, getValue, hashCode, isSupported, size, toMutablePeriod, toPeriod




Field Detail

ZERO
public static final Seconds ZERO
Constant representing zero seconds.

ONE
public static final Seconds ONE
Constant representing one second.

TWO
public static final Seconds TWO
Constant representing two seconds.

THREE
public static final Seconds THREE
Constant representing three seconds.

MAX_VALUE
public static final Seconds MAX_VALUE
Constant representing the maximum number of seconds that can be stored in this object.

MIN_VALUE
public static final Seconds MIN_VALUE
Constant representing the minimum number of seconds that can be stored in this object.


Method Detail

seconds
public static Seconds seconds(int seconds)
Obtains an instance ofSeconds
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

secondsBetween
public static Seconds secondsBetween(ReadableInstant start, ReadableInstant end)
Creates aSeconds
representing the number of whole seconds between the two specified datetimes. Parameters:
start
 the start instant, must not be nullend
 the end instant, must not be null Returns:
 the period in seconds
 Throws:
java.lang.IllegalArgumentException
 if the instants are null or invalid

secondsBetween
public static Seconds secondsBetween(ReadablePartial start, ReadablePartial end)
Creates aSeconds
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 nullend
 the end partial date, must not be null Returns:
 the period in seconds
 Throws:
java.lang.IllegalArgumentException
 if the partials are null or invalid

secondsIn
public static Seconds secondsIn(ReadableInterval interval)
Creates aSeconds
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

standardSecondsIn
public static Seconds standardSecondsIn(ReadablePeriod period)
Creates a newSeconds
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 days.
 One day consists of 24 hours.
 One hour consists of 60 minutes.
 One minute consists of 60 seconds.
 One second consists of 1000 milliseconds.
 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

parseSeconds
public static Seconds parseSeconds(java.lang.String periodStr)
Creates a newSeconds
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 nonzero. If any other component is nonzero, 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

getFieldType
public DurationFieldType getFieldType()
Gets the duration field type, which isseconds
. Specified by:
getFieldType
in classBaseSingleFieldPeriod
 Returns:
 the period type

getPeriodType
public PeriodType getPeriodType()
Gets the period type, which isseconds
. Specified by:
getPeriodType
in interfaceReadablePeriod
 Specified by:
getPeriodType
in classBaseSingleFieldPeriod
 Returns:
 the period type

toStandardWeeks
public Weeks toStandardWeeks()
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

toStandardDays
public Days toStandardDays()
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

toStandardHours
public Hours toStandardHours()
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

toStandardMinutes
public Minutes toStandardMinutes()
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

toStandardDuration
public Duration toStandardDuration()
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

getSeconds
public int getSeconds()
Gets the number of seconds that this period represents. Returns:
 the number of seconds in the period

plus
public Seconds plus(int 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 Returns:
 the new period plus the specified number of seconds
 Throws:
java.lang.ArithmeticException
 if the result overflows an int

plus
public Seconds plus(Seconds 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

minus
public Seconds minus(int 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 Returns:
 the new period minus the specified number of seconds
 Throws:
java.lang.ArithmeticException
 if the result overflows an int

minus
public Seconds minus(Seconds 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

multipliedBy
public Seconds multipliedBy(int scalar)
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

dividedBy
public Seconds dividedBy(int divisor)
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

negated
public Seconds negated()
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

isGreaterThan
public boolean isGreaterThan(Seconds other)
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

isLessThan
public boolean isLessThan(Seconds other)
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

toString
public java.lang.String toString()
Gets this instance as a String in the ISO8601 duration format.For example, "PT4S" represents 4 seconds.
 Specified by:
toString
in interfaceReadablePeriod
 Overrides:
toString
in classjava.lang.Object
 Returns:
 the value as an ISO8601 string

