Dough Lea's util.concurrent package 1.3.4 · EDU.oswego.cs.dl.util.concurrent.SynchronizedShort

Modifier and Type	Field and Description
protected short	value_

Access	Constructor and Description
public	SynchronizedShort(short initialValue) Make a new SynchronizedShort with the given initial value, and using its own internal lock.
public	SynchronizedShort(short initialValue, Object lock) Make a new SynchronizedShort with the given initial value, and using the supplied lock.

Method Summary

Modifier and Type	Method and Description
public short	Returns: the new value add(short amount) Add amount to value (i.e., set value += amount)
public short	Returns: the new value and(short b) Set value to value & b.
public boolean	Returns: true if successful commit(short assumedValue, short newValue) Set value to newValue only if it is currently assumedValue.
public int	compareTo(short the object to be compared. other) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public int	compareTo(SynchronizedShort 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 short	Returns: the new value complement() Set the value to its complement
public short	Returns: the new value decrement() Decrement the value.
public short	Returns: the new value divide(short 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 short	get() Return the current value
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public short	Returns: the new value increment() Increment the value.
public short	Returns: the new value multiply(short factor) Multiply value by factor (i.e., set value *= factor)
public short	Returns: the new value negate() Set the value to the negative of its old value
public short	Returns: the new value or(short b) Set value to value \| b.
public short	Returns: the old value set(short newValue) Set to newValue.
public short	Returns: the new value subtract(short amount) Subtract amount from value (i.e., set value -= amount)
public short	Returns: the new value swap(SynchronizedShort other) Atomically swap values with another SynchronizedShort.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public short	Returns: the new value xor(short b) Set value to value ^ b.

Inherited from EDU.oswego.cs.dl.util.concurrent.SynchronizedVariable:: execute getLock

value_	back to summary
protected short value_

SynchronizedShort	back to summary
public SynchronizedShort(short initialValue) Make a new SynchronizedShort with the given initial value, and using its own internal lock.

SynchronizedShort	back to summary
public SynchronizedShort(short initialValue, Object lock) Make a new SynchronizedShort with the given initial value, and using the supplied lock.

Method Detail

add	back to summary
public short add(short amount) Add amount to value (i.e., set value += amount) Returns:short the new value

add

back to summary

public short add(short amount)

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

Returns:short: the new value

and	back to summary
public short and(short b) Set value to value & b. Returns:short the new value

and

back to summary

public short and(short b)

Set value to value & b.

Returns:short: the new value

commit	back to summary
public boolean commit(short assumedValue, short newValue) Set value to newValue only if it is currently assumedValue. Returns:boolean true if successful

commit

back to summary

public boolean commit(short assumedValue, short newValue)

Set value to newValue only if it is currently assumedValue.

Returns:boolean: true if successful

compareTo back to summary

compareTo	back to summary
public int compareTo(short 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:short 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.

public int compareTo(short 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:short: 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.

compareTo back to summary

compareTo	back to summary
public int compareTo(SynchronizedShort 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:SynchronizedShort 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.

public int compareTo(SynchronizedShort 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 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:SynchronizedShort: 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.

compareTo back to summary

compareTo	back 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.

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 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.

complement	back to summary
public short complement() Set the value to its complement Returns:short the new value

complement

back to summary

public short complement()

Set the value to its complement

Returns:short: the new value

decrement	back to summary
public short decrement() Decrement the value. Returns:short the new value

decrement

back to summary

public short decrement()

Decrement the value.

Returns:short: the new value

divide	back to summary
public short divide(short factor) Divide value by factor (i.e., set value /= factor) Returns:short the new value

divide

back to summary

public short divide(short factor)

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

Returns:short: the new value

equals back to summary

equals	back 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.

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.

get	back to summary
public final short get() Return the current value

hashCode back to summary

hashCode	back 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.

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.

increment	back to summary
public short increment() Increment the value. Returns:short the new value

increment

back to summary

public short increment()

Increment the value.

Returns:short: the new value

multiply	back to summary
public short multiply(short factor) Multiply value by factor (i.e., set value *= factor) Returns:short the new value

multiply

back to summary

public short multiply(short factor)

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

Returns:short: the new value

negate	back to summary
public short negate() Set the value to the negative of its old value Returns:short the new value

negate

back to summary

public short negate()

Set the value to the negative of its old value

Returns:short: the new value

or	back to summary
public short or(short b) Set value to value \| b. Returns:short the new value

back to summary

public short or(short b)

Set value to value | b.

Returns:short: the new value

set	back to summary
public short set(short newValue) Set to newValue. Returns:short the old value

set

back to summary

public short set(short newValue)

Set to newValue.

Returns:short: the old value

subtract	back to summary
public short subtract(short amount) Subtract amount from value (i.e., set value -= amount) Returns:short the new value

subtract

back to summary

public short subtract(short amount)

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

Returns:short: the new value

swap	back to summary
public short swap(SynchronizedShort other) Atomically swap values with another SynchronizedShort. Uses identityHashCode to avoid deadlock when two SynchronizedShorts attempt to simultaneously swap with each other. (Note: Ordering via identyHashCode is not strictly guaranteed by the language specification to return unique, orderable values, but in practice JVMs rely on them being unique.) Returns:short the new value

swap

back to summary

public short swap(SynchronizedShort other)

Atomically swap values with another SynchronizedShort. Uses identityHashCode to avoid deadlock when two SynchronizedShorts attempt to simultaneously swap with each other. (Note: Ordering via identyHashCode is not strictly guaranteed by the language specification to return unique, orderable values, but in practice JVMs rely on them being unique.)

Returns:short: the new value

toString	back 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.

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.