org.joda.time
Class Seconds
- Comparable, ReadablePeriod, Serializable
public final class Seconds
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.
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.
|
Seconds | dividedBy(int divisor) - Returns a new instance with the seconds divided by the specified divisor.
|
DurationFieldType | getFieldType() - Gets the duration field type, which is
seconds .
|
PeriodType | getPeriodType() - Gets the period type, which is
seconds .
|
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(String periodStr) - Creates a new
Seconds 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 of
Seconds that may be cached.
|
static Seconds | secondsBetween(ReadableInstant start, ReadableInstant end) - Creates a
Seconds representing the number of whole seconds
between the two specified datetimes.
|
static Seconds | secondsBetween(ReadablePartial start, ReadablePartial end) - Creates a
Seconds representing the number of whole seconds
between the two specified partial datetimes.
|
static Seconds | secondsIn(ReadableInterval interval) - Creates a
Seconds representing the number of whole seconds
in the specified interval.
|
static Seconds | standardSecondsIn(ReadablePeriod period) - Creates a new
Seconds 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.
|
String | toString() - Gets this instance as a String in the ISO8601 duration format.
|
between , between , compareTo , equals , get , getFieldType , getFieldType , getPeriodType , getValue , getValue , hashCode , isSupported , setValue , size , standardPeriodIn , toMutablePeriod , toPeriod |
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.
ONE
public static final Seconds ONE
Constant representing one second.
THREE
public static final Seconds THREE
Constant representing three seconds.
TWO
public static final Seconds TWO
Constant representing two seconds.
ZERO
public static final Seconds ZERO
Constant representing zero seconds.
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.
divisor
- the amount to divide by, may be negative
- the new period divided by the specified divisor
getSeconds
public int getSeconds()
Gets the number of seconds that this period represents.
- the number of seconds in the period
isGreaterThan
public boolean isGreaterThan(Seconds other)
Is this seconds instance greater than the specified number of seconds.
other
- the other period, null means zero
- 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.
other
- the other period, null means zero
- true if this seconds instance is less than the specified one
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.
seconds
- the amount of seconds to take away, may be negative
- the new period minus the specified number of seconds
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.
seconds
- the amount of seconds to take away, may be negative, null means zero
- the new period minus the specified number of seconds
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.
scalar
- the amount to multiply by, may be negative
- the new period multiplied by the specified scalar
negated
public Seconds negated()
Returns a new instance with the seconds value negated.
- the new period with a negated value
parseSeconds
public static Seconds parseSeconds(String periodStr)
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.
periodStr
- the period string, null returns zero
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.
seconds
- the amount of seconds to add, may be negative
- the new period plus the specified number of seconds
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.
seconds
- the amount of seconds to add, may be negative, null means zero
- the new period plus the specified number of seconds
seconds
public static Seconds seconds(int seconds)
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.
seconds
- the number of seconds to obtain an instance for
secondsBetween
public static Seconds secondsBetween(ReadableInstant start,
ReadableInstant end)
Creates a Seconds
representing the number of whole seconds
between the two specified datetimes.
start
- the start instant, must not be nullend
- the end instant, must not be null
secondsBetween
public static Seconds secondsBetween(ReadablePartial start,
ReadablePartial end)
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.
start
- the start partial date, must not be nullend
- the end partial date, must not be null
secondsIn
public static Seconds secondsIn(ReadableInterval interval)
Creates a Seconds
representing the number of whole seconds
in the specified interval.
interval
- the interval to extract seconds from, null returns zero
standardSecondsIn
public static Seconds standardSecondsIn(ReadablePeriod period)
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.
period
- the period to get the number of hours from, null returns zero
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.
- a period representing the number of days 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.
- a duration equivalent to 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.
- 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.
- a period representing the number of minutes for this number of seconds
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.
- a period representing the number of whole weeks for this number of seconds
toString
public String toString()
Gets this instance as a String in the ISO8601 duration format.
For example, "PT4S" represents 4 seconds.
- toString in interface ReadablePeriod
- the value as an ISO8601 string
Copyright (c) 2001-2006 - Joda.org