org.jsfml.system

Class Time

java.lang.Object

org.jsfml.system.Time

All Implemented Interfaces:

Serializable, Comparable<Time>

public final class Time
extends Object
implements Comparable<Time>, Serializable

Represents a time period and provides functionality to convert between various time units, as well as arithmetic operations on time intervals.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Time	ZERO A time object that represents a zero time period, ie with no duration.

Method Summary

Methods

Modifier and Type	Method and Description
static Time	add(Time a, Time b) Adds two time values.
long	asMicroseconds() Returns the time value in microseconds.
long	asMilliseconds() Returns the time value in milliseconds.
float	asSeconds() Returns the time value in seconds.
int	compareTo(Time t)
static Time	div(Time a, float s) Scales a time by dividing it by a scalar.
boolean	equals(Object o)
static Time	getMicroseconds(long microseconds) Creates a new time with the given value.
static Time	getMilliseconds(long milliseconds) Creates a new time with the given value.
static Time	getSeconds(float seconds) Creates a new time with the given value.
int	hashCode()
static Time	mul(Time a, float s) Scales a time by multiplying its value by a scalar.
static float	ratio(Time a, Time b) Computes a time period's ratio of another time period.
static Time	sub(Time a, Time b) Subtracts two time values.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ZERO

public static final Time ZERO

A time object that represents a zero time period, ie with no duration.

Method Detail

getSeconds

public static Time getSeconds(float seconds)

Creates a new time with the given value.

Parameters:

seconds - the time value, in seconds.

Returns:

a new time with the given value.

getMilliseconds

public static Time getMilliseconds(long milliseconds)

Creates a new time with the given value.

Parameters:

milliseconds - the time value in milliseconds.

Returns:

a new time with the given value.

getMicroseconds

public static Time getMicroseconds(long microseconds)

Creates a new time with the given value.

Parameters:

microseconds - the time value in microseconds.

Returns:

a new time with the given value.

add

public static Time add(Time a,
       Time b)

Adds two time values.

Parameters:

a - the first operand.

b - The second operand.

Returns:

a new time, representing the sum of the two times.

sub

public static Time sub(Time a,
       Time b)

Subtracts two time values.

Parameters:

a - the minuend.

b - the subtrahend.

Returns:

a new time, representing the difference between the two times.

mul

public static Time mul(Time a,
       float s)

Scales a time by multiplying its value by a scalar.

Parameters:

a - the time to scale.

s - the scalar.

Returns:

a new time, representing the given time scaled by the given factor.

div

public static Time div(Time a,
       float s)

Scales a time by dividing it by a scalar.

Parameters:

a - the time to scale.

s - the scalar.

Returns:

a new time, representing the given time scaled by the given factor.

ratio

public static float ratio(Time a,
          Time b)

Computes a time period's ratio of another time period.

Parameters:

a - The first time period.

b - The second time period.

Returns:

The ratio of the first time period to the second time period.

asSeconds

public float asSeconds()

Returns the time value in seconds.

Returns:

the time value in seconds.

asMilliseconds

public long asMilliseconds()

Returns the time value in milliseconds.

Returns:

the time value in milliseconds.

asMicroseconds

public long asMicroseconds()

Returns the time value in microseconds.

Returns:

the time value in microseconds.

compareTo

public int compareTo(Time t)

Specified by:

compareTo in interface Comparable<Time>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object