Top Description Fields Constructors Methods
EDU.oswego.cs.dl.util.concurrent

public Class SynchronizedLong

extends SynchronizedVariable
implements Comparable, Cloneable
Class Inheritance
All Implemented Interfaces
java.lang.Cloneable, java.lang.Comparable
Known Direct Subclasses
EDU.oswego.cs.dl.util.concurrent.WaitableLong
A class useful for offloading synch for long instance variables.
See Also
Introduction to this package.

Field Summary

Modifier and TypeField and Description
protected long
value_

Inherited from EDU.oswego.cs.dl.util.concurrent.SynchronizedVariable:
lock_

Constructor Summary

AccessConstructor and Description
public
SynchronizedLong(long initialValue)

Make a new SynchronizedLong with the given initial value, and using its own internal lock.

public
SynchronizedLong(long initialValue, Object lock)

Make a new SynchronizedLong with the given initial value, and using the supplied lock.

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

the new value
add(long amount)

Add amount to value (i.e., set value += amount)

public long

Returns:

the new value
and(long b)

Set value to value & b.

public boolean

Returns:

true if successful
commit(long assumedValue, long newValue)

Set value to newValue only if it is currently assumedValue.

public int
compareTo(long
the object to be compared.
other)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.
public int
compareTo(SynchronizedLong
the object to be compared.
other)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.
public int
compareTo(Object
the object to be compared.
other)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.
public long

Returns:

the new value
complement()

Set the value to its complement

public long

Returns:

the new value
decrement()

Decrement the value.

public long

Returns:

the new value
divide(long factor)

Divide value by factor (i.e., set value /= factor)

public boolean
equals(Object
the reference object with which to compare.
other)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public final long
get()

Return the current value

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public long

Returns:

the new value
increment()

Increment the value.

public long

Returns:

the new value
multiply(long factor)

Multiply value by factor (i.e., set value *= factor)

public long

Returns:

the new value
negate()

Set the value to the negative of its old value

public long

Returns:

the new value
or(long b)

Set value to value | b.

public long

Returns:

the old value
set(long newValue)

Set to newValue.

public long

Returns:

the new value
subtract(long amount)

Subtract amount from value (i.e., set value -= amount)

public long

Returns:

the new value
swap(SynchronizedLong other)

Atomically swap values with another SynchronizedLong.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public long

Returns:

the new value
xor(long b)

Set value to value ^ b.

Inherited from EDU.oswego.cs.dl.util.concurrent.SynchronizedVariable:
executegetLock

Field Detail

value_back to summary
protected long value_

Constructor Detail

SynchronizedLongback to summary
public SynchronizedLong(long initialValue)

Make a new SynchronizedLong with the given initial value, and using its own internal lock.

SynchronizedLongback to summary
public SynchronizedLong(long initialValue, Object lock)

Make a new SynchronizedLong with the given initial value, and using the supplied lock.

Method Detail

addback to summary
public long add(long amount)

Add amount to value (i.e., set value += amount)

Returns:long

the new value

andback to summary
public long and(long b)

Set value to value & b.

Returns:long

the new value

commitback to summary
public boolean commit(long assumedValue, long newValue)

Set value to newValue only if it is currently assumedValue.

Returns:boolean

true if successful

compareToback to summary
public int compareTo(long other)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
other:long

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

compareToback to summary
public int compareTo(SynchronizedLong other)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
other:SynchronizedLong

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

compareToback to summary
public int compareTo(Object other)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
other:Object

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

complementback to summary
public long complement()

Set the value to its complement

Returns:long

the new value

decrementback to summary
public long decrement()

Decrement the value.

Returns:long

the new value

divideback to summary
public long divide(long factor)

Divide value by factor (i.e., set value /= factor)

Returns:long

the new value

equalsback to summary
public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
other:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

getback to summary
public final long get()

Return the current value

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

incrementback to summary
public long increment()

Increment the value.

Returns:long

the new value

multiplyback to summary
public long multiply(long factor)

Multiply value by factor (i.e., set value *= factor)

Returns:long

the new value

negateback to summary
public long negate()

Set the value to the negative of its old value

Returns:long

the new value

orback to summary
public long or(long b)

Set value to value | b.

Returns:long

the new value

setback to summary
public long set(long newValue)

Set to newValue.

Returns:long

the old value

subtractback to summary
public long subtract(long amount)

Subtract amount from value (i.e., set value -= amount)

Returns:long

the new value

swapback to summary
public long swap(SynchronizedLong other)

Atomically swap values with another SynchronizedLong. Uses identityHashCode to avoid deadlock when two SynchronizedLongs attempt to simultaneously swap with each other.

Returns:long

the new value

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

xorback to summary
public long xor(long b)

Set value to value ^ b.

Returns:long

the new value