io.humble.ferry

Class AtomicInteger

java.lang.Object

io.humble.ferry.AtomicInteger

public class AtomicInteger
extends Object

Internal only. Atomic Integer represents Integers than can be updated
atomically from native code.

This object is NOT meant to be called from Java (in fact, that'd be stupid
since you'd just be calling from native code back into Java). It's
here so that native code inside a JVM can have access to portable
thread-safe objects.

And that said, this method is really only Atomic if running inside a
Java JVM (or other virtual machine that can provide the functionality).
If running in a standalone C++ program there
is no current guarantee of Atomicity.

The object just forwards to the Java object:
java.util.concurrent.atomic.AtomicInteger

Constructor Summary

Constructors

Constructor and Description
AtomicInteger()
AtomicInteger(int arg0)

Method Summary

Modifier and Type	Method and Description
int	addAndGet(int arg0)
boolean	compareAndSet(int expected, int update) Compare the current value to expected, and if they are equal, set the current value to update.
int	decrementAndGet()
void	delete() Releases any underlying native memory and marks this object as invalid.
boolean	equals(Object obj) Compares two values, returning true if the underlying objects in native code are the same object.
int	get()
int	getAndAdd(int arg0)
int	getAndDecrement()
int	getAndIncrement()
int	getAndSet(int arg0)
int	hashCode() Get a hashable value for this object.
int	incrementAndGet()
boolean	isAtomic()
void	set(int arg0)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AtomicInteger

public AtomicInteger()

AtomicInteger

public AtomicInteger(int arg0)

Method Detail

equals

public boolean equals(Object obj)

Compares two values, returning true if the underlying objects in native code are the same object. That means you can have two different Java objects, but when you do a comparison, you'll find out they are the EXACT same object.

Overrides:

equals in class Object

Returns:

True if the underlying native object is the same. False otherwise.

hashCode

public int hashCode()

Get a hashable value for this object.

Overrides:

hashCode in class Object

Returns:

the hashable value.

delete

public void delete()

Releases any underlying native memory and marks this object as invalid.

Normally Ferry manages when to release native memory.

In the unlikely event you want to control EXACTLY when a native object is released, each Humble object has a delete() method that you can use. Once you call delete(), you must ENSURE your object is never referenced again from that Java object -- Ferry tries to help you avoid crashes if you accidentally use an object after deletion but on this but we cannot offer 100% protection (specifically if another thread is accessing that object EXACTLY when you delete() it).

get

public int get()

set

public void set(int arg0)

getAndSet

public int getAndSet(int arg0)

getAndIncrement

public int getAndIncrement()

getAndDecrement

public int getAndDecrement()

getAndAdd

public int getAndAdd(int arg0)

incrementAndGet

public int incrementAndGet()

decrementAndGet

public int decrementAndGet()

addAndGet

public int addAndGet(int arg0)

compareAndSet

public boolean compareAndSet(int expected,
                             int update)

Compare the current value to expected, and if
they are equal, set the current value to update.

Parameters:

expected - the value expected

update - the value to update to

Returns:

true if equal

isAtomic

public boolean isAtomic()

Returns:

true if we're actually able to guarantee
atomicity; false if we can't.