org.multiverse.transactional.refs
Class IntRef

java.lang.Object
  org.multiverse.transactional.refs.IntRef

public class IntRef
extends Object

A Ref for storing an int.

Author:

Peter Veentjer

Constructor Summary

IntRef()
Creates a new IntRef with the 0 as value.

IntRef(int value)
Creates a new IntRef with the given value.

Method Summary

void	await(int desired) Waits till the value is equal to the desired value.
int	awaitLargerOrEqualThan(int than) Waits till the value is equal or larger than.
int	awaitLargerThan(int than) Waits till this value is larger than.
int	awaitNotEqualTo(int than)
int	awaitSmallerOrEqualThan(int than)
int	awaitSmallerThan(int than)
int	dec() Decreases the value in this IntRef by one.
int	dec(int amount) Decreases the value of this IntRef by the given amount.
boolean	equals(Object thatObj)
int	get() Gets the current value.
int	hashCode()
int	inc() Increases the value in this IntRef by one.
int	inc(int amount) Increase the value of this IntRef by the given amount.
int	set(int newValue) Sets the new value and returns the old value.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IntRef

public IntRef()

Creates a new IntRef with the 0 as value.

IntRef

public IntRef(int value)

Creates a new IntRef with the given value.

Parameters:

value - the initial value of this IntRef.

Method Detail

get

public final int get()

Gets the current value.

Returns:

gets the current value.

set

public final int set(int newValue)

Sets the new value and returns the old value.

Parameters:

newValue - the new value.

Returns:

the previous value.

dec

public final int dec()

Decreases the value in this IntRef by one.

Returns:

the decreased value.

inc

public final int inc()

Increases the value in this IntRef by one.

Returns:

the increased value.

inc

public final int inc(int amount)

Increase the value of this IntRef by the given amount.

Parameters:

amount - the amount the value needs to be increased with. Value is allowed to be 0 or negative.

Returns:

the increased value.

dec

public final int dec(int amount)

Decreases the value of this IntRef by the given amount.

Parameters:

amount - the amount the value needs to be decreased with. Value is allowed to be 0 or negative.

Returns:

the decreased value.

await

public final void await(int desired)

Waits till the value is equal to the desired value.

Parameters:

desired - the value to wait for.

awaitLargerThan

public final int awaitLargerThan(int than)

Waits till this value is larger than.

Parameters:

than - the value to wait for.

Returns:

the value that currently is active.

awaitLargerOrEqualThan

public final int awaitLargerOrEqualThan(int than)

Waits till the value is equal or larger than.

Parameters:

than -

Returns:

awaitSmallerThan

public final int awaitSmallerThan(int than)

awaitSmallerOrEqualThan

public final int awaitSmallerOrEqualThan(int than)

awaitNotEqualTo

public final int awaitNotEqualTo(int than)

toString

public final String toString()

Overrides:

toString in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object thatObj)

Overrides:

equals in class Object