Package ch.njol.skript.util

Class Timespan

java.lang.Object

ch.njol.skript.util.Timespan

All Implemented Interfaces:

YggdrasilSerializable, Comparable<Timespan>, TemporalAmount

public class Timespan
extends Object
implements YggdrasilSerializable, Comparable<Timespan>, TemporalAmount

Represents a duration of time, such as 2 days, similar to Duration.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Timespan.TimePeriod	Represents the unit used for the current Timespan.

Nested classes/interfaces inherited from interface ch.njol.yggdrasil.YggdrasilSerializable

YggdrasilSerializable.YggdrasilExtendedSerializable, YggdrasilSerializable.YggdrasilRobustEnum, YggdrasilSerializable.YggdrasilRobustSerializable

Constructor Summary

Constructors

Constructor	Description
Timespan()
Timespan(long millis)	Builds a Timespan from the given milliseconds.
Timespan(Timespan.TimePeriod timePeriod, long time)	Builds a Timespan from the given long parameter of a specific Timespan.TimePeriod.

Method Summary

Modifier and Type	Method	Description
Timespan	add(Timespan timespan)	Safely adds the specified timespan to this timespan, handling potential overflow.
Temporal	addTo(Temporal temporal)
int	compareTo(@Nullable Timespan time)
Timespan	difference(Timespan timespan)	Calculates the difference between the specified timespan and this timespan.
boolean	equals(@Nullable Object obj)
static Timespan	fromDuration(Duration duration)
static Timespan	fromTicks(long ticks)	Deprecated, for removal: This API element is subject to removal in a future version. Use Timespan(TimePeriod, long) instead.
static Timespan	fromTicks_i(long ticks)	Deprecated, for removal: This API element is subject to removal in a future version. Use Timespan(TimePeriod, long) instead.
long	get(TemporalUnit unit)
long	getAs(Timespan.TimePeriod timePeriod)
Duration	getDuration()
long	getMilliSeconds()	Deprecated, for removal: This API element is subject to removal in a future version. Use getAs(TimePeriod) instead.
long	getTicks()	Deprecated, for removal: This API element is subject to removal in a future version. Use getAs(TimePeriod) instead.
long	getTicks_i()	Deprecated, for removal: This API element is subject to removal in a future version. Use getAs(TimePeriod) instead.
List<TemporalUnit>	getUnits()
int	hashCode()
static @Nullable Timespan	parse(String value)
static @Nullable Timespan	parse(String value, ParseContext context)
Timespan	subtract(Timespan timespan)	Safely subtracts the specified timespan from this timespan, handling potential underflow.
Temporal	subtractFrom(Temporal temporal)
String	toString()
String	toString(int flags)
static String	toString(long millis)
static String	toString(long millis, int flags)

Methods inherited from class java.lang.Object

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

Constructor Details

Timespan

public Timespan()

Timespan

public Timespan(long millis)

Builds a Timespan from the given milliseconds.

Parameters:

millis - The milliseconds of Timespan

Timespan

public Timespan(Timespan.TimePeriod timePeriod,
 long time)

Builds a Timespan from the given long parameter of a specific Timespan.TimePeriod.

Parameters:

timePeriod - The requested TimePeriod

time - The time of the requested TimePeriod

Method Details

parse

@Nullable
public static @Nullable Timespan parse(String value)

parse

@Nullable
public static @Nullable Timespan parse(String value,
 ParseContext context)

fromDuration

public static Timespan fromDuration(Duration duration)

toString

public static String toString(long millis)

toString

public static String toString(long millis,
 int flags)

fromTicks

@Deprecated(since="2.10.0",
            forRemoval=true)
public static Timespan fromTicks(long ticks)

Deprecated, for removal: This API element is subject to removal in a future version.

Use Timespan(TimePeriod, long) instead.

fromTicks_i

@Deprecated(since="2.10.0",
            forRemoval=true)
public static Timespan fromTicks_i(long ticks)

Deprecated, for removal: This API element is subject to removal in a future version.

Use Timespan(TimePeriod, long) instead.

getMilliSeconds

@Deprecated(since="2.10.0",
            forRemoval=true)
public long getMilliSeconds()

Deprecated, for removal: This API element is subject to removal in a future version.

Use getAs(TimePeriod) instead.

getTicks

@Deprecated(since="2.10.0",
            forRemoval=true)
public long getTicks()

Deprecated, for removal: This API element is subject to removal in a future version.

Use getAs(TimePeriod) instead.

getTicks_i

@Deprecated(since="2.10.0",
            forRemoval=true)
public long getTicks_i()

Deprecated, for removal: This API element is subject to removal in a future version.

Use getAs(TimePeriod) instead.

getAs

public long getAs(Timespan.TimePeriod timePeriod)

Returns:

the amount of TimePeriod this timespan represents.

getDuration

public Duration getDuration()

Returns:

Converts this timespan to a Duration.

add

public Timespan add(Timespan timespan)

Safely adds the specified timespan to this timespan, handling potential overflow.

Parameters:

timespan - The timespan to add to this timespan

Returns:

a new Timespan object

subtract

public Timespan subtract(Timespan timespan)

Safely subtracts the specified timespan from this timespan, handling potential underflow.

Parameters:

timespan - The timespan to subtract from this timespan

Returns:

a new Timespan object

difference

public Timespan difference(Timespan timespan)

Calculates the difference between the specified timespan and this timespan.

Parameters:

timespan - The timespan to get the difference of

Returns:

a new Timespan object

get

public long get(TemporalUnit unit)

Specified by:

get in interface TemporalAmount

getUnits

public List<TemporalUnit> getUnits()

Specified by:

getUnits in interface TemporalAmount

addTo

public Temporal addTo(Temporal temporal)

Specified by:

addTo in interface TemporalAmount

subtractFrom

public Temporal subtractFrom(Temporal temporal)

Specified by:

subtractFrom in interface TemporalAmount

compareTo

public int compareTo(@Nullable
 @Nullable Timespan time)

Specified by:

compareTo in interface Comparable<Timespan>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable
 @Nullable Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(int flags)