| java.lang.Object
 org.joda.time.base.BaseSingleFieldPeriod
org.joda.time.Seconds
| Seconds | | final public class Seconds extends BaseSingleFieldPeriod (Code) | | 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:
Stephen Colebourne
since:
1.4 |
| Field Summary | |
| final public static Seconds | MAX_VALUE
Constant representing the maximum number of seconds that can be stored in this object. | | final public static Seconds | MIN_VALUE
Constant representing the minimum number of seconds that can be stored in this object. | | final public static Seconds | ONE
Constant representing one second. | | final public static Seconds | THREE
Constant representing three seconds. | | final public static Seconds | TWO
Constant representing two seconds. | | final public static Seconds | ZERO
Constant representing zero seconds. |
| Method Summary | |
| public Seconds | dividedBy(int divisor)
Returns a new instance with the seconds divided by the specified divisor. | | public DurationFieldType | getFieldType()
Gets the duration field type, which is seconds. | | public PeriodType | getPeriodType()
Gets the period type, which is seconds. | | public int | getSeconds()
Gets the number of seconds that this period represents. | | public boolean | isGreaterThan(Seconds other)
Is this seconds instance greater than the specified number of seconds. | | public boolean | isLessThan(Seconds other)
Is this seconds instance less than the specified number of seconds. | | public Seconds | minus(int seconds)
Returns a new instance with the specified number of seconds taken away. | | public Seconds | minus(Seconds seconds)
Returns a new instance with the specified number of seconds taken away. | | public Seconds | multipliedBy(int scalar)
Returns a new instance with the seconds multiplied by the specified scalar. | | public Seconds | negated()
Returns a new instance with the seconds value negated. | | 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. | | public Seconds | plus(int seconds)
Returns a new instance with the specified number of seconds added. | | public Seconds | plus(Seconds seconds)
Returns a new instance with the specified number of seconds added. | | public static Seconds | seconds(int seconds)
Obtains an instance of Seconds that may be cached. | | public static Seconds | secondsBetween(ReadableInstant start, ReadableInstant end)
Creates a Seconds representing the number of whole seconds
between the two specified datetimes. | | public static Seconds | secondsBetween(ReadablePartial start, ReadablePartial end)
Creates a Seconds representing the number of whole seconds
between the two specified partial datetimes. | | public static Seconds | secondsIn(ReadableInterval interval)
Creates a Seconds representing the number of whole seconds
in the specified interval. | | 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. | | 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. | | 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. | | 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. | | 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. | | 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. | | public String | toString()
Gets this instance as a String in the ISO8601 duration format. |
| MAX_VALUE | | final public static Seconds MAX_VALUE(Code) | | Constant representing the maximum number of seconds that can be stored in this object.
|
| MIN_VALUE | | final public static Seconds MIN_VALUE(Code) | | Constant representing the minimum number of seconds that can be stored in this object.
|
| ONE | | final public static Seconds ONE(Code) | | Constant representing one second.
|
| THREE | | final public static Seconds THREE(Code) | | Constant representing three seconds.
|
| TWO | | final public static Seconds TWO(Code) | | Constant representing two seconds.
|
| ZERO | | final public static Seconds ZERO(Code) | | Constant representing zero seconds.
|
| dividedBy | | public Seconds dividedBy(int divisor)(Code) | | 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 the new period divided by the specified divisor
throws:
ArithmeticException - if the divisor is zero |
| getFieldType | | public DurationFieldType getFieldType()(Code) | | Gets the duration field type, which is seconds.
the period type |
| getPeriodType | | public PeriodType getPeriodType()(Code) | | Gets the period type, which is seconds.
the period type |
| getSeconds | | public int getSeconds()(Code) | | Gets the number of seconds that this period represents.
the number of seconds in the period |
| isGreaterThan | | public boolean isGreaterThan(Seconds other)(Code) | | Is this seconds instance greater than the specified number of seconds.
Parameters:
other - the other period, null means zero true if this seconds instance is greater than the specified one |
| isLessThan | | public boolean isLessThan(Seconds other)(Code) | | Is this seconds instance less than the specified number of seconds.
Parameters:
other - the other period, null means zero true if this seconds instance is less than the specified one |
| minus | | public Seconds minus(int seconds)(Code) | | 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 the new period minus the specified number of seconds
throws:
ArithmeticException - if the result overflows an int |
| minus | | public Seconds minus(Seconds seconds)(Code) | | 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 the new period minus the specified number of seconds
throws:
ArithmeticException - if the result overflows an int |
| multipliedBy | | public Seconds multipliedBy(int scalar)(Code) | | 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 the new period multiplied by the specified scalar
throws:
ArithmeticException - if the result overflows an int |
| negated | | public Seconds negated()(Code) | | Returns a new instance with the seconds value negated.
the new period with a negated value
throws:
ArithmeticException - if the result overflows an int |
| parseSeconds | | public static Seconds parseSeconds(String periodStr)(Code) | | 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 the period in seconds
throws:
IllegalArgumentException - if the string format is invalid |
| plus | | public Seconds plus(int seconds)(Code) | | 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 the new period plus the specified number of seconds
throws:
ArithmeticException - if the result overflows an int |
| plus | | public Seconds plus(Seconds seconds)(Code) | | 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 the new period plus the specified number of seconds
throws:
ArithmeticException - if the result overflows an int |
| seconds | | public static Seconds seconds(int seconds)(Code) | | 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 the instance of Seconds |
| secondsBetween | | public static Seconds secondsBetween(ReadableInstant start, ReadableInstant end)(Code) | | Creates a Seconds representing the number of whole seconds
between the two specified datetimes.
Parameters:
start - the start instant, must not be null
Parameters:
end - the end instant, must not be null the period in seconds
throws:
IllegalArgumentException - if the instants are null or invalid |
| secondsBetween | | public static Seconds secondsBetween(ReadablePartial start, ReadablePartial end)(Code) | | 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
Parameters:
end - the end partial date, must not be null the period in seconds
throws:
IllegalArgumentException - if the partials are null or invalid |
| secondsIn | | public static Seconds secondsIn(ReadableInterval interval)(Code) | | Creates a Seconds representing the number of whole seconds
in the specified interval.
Parameters:
interval - the interval to extract seconds from, null returns zero the period in seconds
throws:
IllegalArgumentException - if the partials are null or invalid |
| standardSecondsIn | | public static Seconds standardSecondsIn(ReadablePeriod period)(Code) | | 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 the period in seconds
throws:
IllegalArgumentException - if the period contains imprecise duration values |
| toStandardDays | | public Days toStandardDays()(Code) | | 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()(Code) | | 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()(Code) | | 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()(Code) | | 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()(Code) | | 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()(Code) | | Gets this instance as a String in the ISO8601 duration format.
For example, "PT4S" represents 4 seconds.
the value as an ISO8601 string |
|
|