org.apache.cassandra.config

Class DurationSpec.IntSecondsBound

java.lang.Object

org.apache.cassandra.config.DurationSpec

org.apache.cassandra.config.DurationSpec.IntSecondsBound

Enclosing class:

DurationSpec

public static final class DurationSpec.IntSecondsBound
extends DurationSpec

Represents a duration used for Cassandra configuration. The bound is [0, Integer.MAX_VALUE) in seconds. If the user sets a different unit - we still validate that converted to seconds the quantity will not exceed that upper bound. (CASSANDRA-17571)

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.cassandra.config.DurationSpec

DurationSpec.IntMillisecondsBound, DurationSpec.IntMinutesBound, DurationSpec.IntSecondsBound, DurationSpec.LongMillisecondsBound, DurationSpec.LongNanosecondsBound, DurationSpec.LongSecondsBound

Constructor Summary

Constructors

Constructor and Description
IntSecondsBound(long seconds) Creates a DurationSpec.IntSecondsBound of the specified amount in seconds.
IntSecondsBound(long quantity, java.util.concurrent.TimeUnit unit) Creates a DurationSpec.IntSecondsBound of the specified amount in the specified unit.
IntSecondsBound(java.lang.String value) Creates a DurationSpec.IntSecondsBound of the specified amount.

Method Summary

Modifier and Type	Method and Description
static DurationSpec.IntSecondsBound	inSecondsString(java.lang.String value) Creates a DurationSpec.IntSecondsBound of the specified amount in seconds, expressed either as the number of seconds without unit, or as a regular quantity with unit.
int	toMilliseconds() Returns this duration in number of milliseconds as an int
int	toSeconds() Returns this duration in number of seconds as an int

Methods inherited from class org.apache.cassandra.config.DurationSpec

equals, hashCode, quantity, to, toString, unit

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IntSecondsBound

public IntSecondsBound(java.lang.String value)

Creates a DurationSpec.IntSecondsBound of the specified amount. The bound is [0, Integer.MAX_VALUE) in seconds. The bound is [0, Integer.MAX_VALUE) in seconds.

Parameters:

value - the duration

IntSecondsBound

public IntSecondsBound(long quantity,
                       java.util.concurrent.TimeUnit unit)

Creates a DurationSpec.IntSecondsBound of the specified amount in the specified unit. The bound is [0, Integer.MAX_VALUE) in seconds.

Parameters:

quantity - where quantity shouldn't be bigger than Integer.MAX_VALUE - 1 in seconds

unit - in which the provided quantity is

IntSecondsBound

public IntSecondsBound(long seconds)

Creates a DurationSpec.IntSecondsBound of the specified amount in seconds. The bound is [0, Integer.MAX_VALUE) in seconds.

Parameters:

seconds - where seconds shouldn't be bigger than Integer.MAX_VALUE-1

Method Detail

inSecondsString

public static DurationSpec.IntSecondsBound inSecondsString(java.lang.String value)

Creates a DurationSpec.IntSecondsBound of the specified amount in seconds, expressed either as the number of seconds without unit, or as a regular quantity with unit. Used in the Converters for a few parameters which changed only type, but not names The bound is [0, Integer.MAX_VALUE) in seconds.

Parameters:

value - where value shouldn't be bigger than Integer.MAX_VALUE-1 in seconds

toMilliseconds

public int toMilliseconds()

Returns this duration in number of milliseconds as an int

Returns:

this duration in number of milliseconds or Integer.MAX_VALUE if the number of milliseconds is too large.

toSeconds

public int toSeconds()

Returns this duration in number of seconds as an int

Returns:

this duration in number of seconds or Integer.MAX_VALUE if the number of seconds is too large.