xmog_int Class Reference

A wrapper type for int proxies. This type wraps the Java int type in a proxy type that uses the JNI jint type to repesent the Java type. Conversion operators allow convenient usage while the get/set methods take an optional xmog_localenv argument for better performance (by saving at least a threadlocal memory access). More...

#include <xmog_java_field.h>

Inheritance diagram for xmog_int:

[legend]Collaboration diagram for xmog_int:

[legend]List of all members.

Public Member Functions
jint	get (xmog_localenv *env=NULL, bool readThrough=false) const
	Returns the value of a int proxy instance.
xmog_int &	operator &= (jint)
	The bitwise-AND assignment operator from the jint type.
jint	operator * () const
	The dereference operator converts to the jint type.
xmog_int &	operator *= (jint)
	The multiplicative assignment operator.
	operator jint () const
	A conversion operator to the int type.
xmog_int &	operator%= (jint)
	The modulo assignment operator from the jint type.
xmog_int &	operator+= (jint)
	The additive assignment operator.
xmog_int &	operator-= (jint)
	The subtractive assignment operator.
xmog_int &	operator/= (jint)
	The divisive assignment operator.
xmog_int &	operator<<= (int)
	The bitwise-shift LEFT assignment operator.
xmog_int &	operator= (jint)
	An assignment operator from the int type.
xmog_int &	operator>>= (int)
	The bitwise-shift RIGHT assignment operator.
xmog_int &	operator^= (jint)
	The bitwise-XOR assignment operator from the jint type.
xmog_int &	operator|= (jint)
	The bitwise-OR assignment operator from the jint type.
void	set (jint i, xmog_localenv *env=NULL, bool writeThrough=false)
	Sets the value of a int proxy.
	xmog_int (xmog_java_ref *_clazz_ref_array, xmog_java_dynamic *_dynamic, xmog_flags _flags=0)
	Creates an instance that acts as a proxy for an indirect element of int type.
	xmog_int (xmog_java_array *_ref, jint _index)
	Creates an instance that acts as a proxy for an element of an int array.

---

Detailed Description

A wrapper type for int proxies. This type wraps the Java int type in a proxy type that uses the JNI jint type to repesent the Java type. Conversion operators allow convenient usage while the get/set methods take an optional xmog_localenv argument for better performance (by saving at least a threadlocal memory access).

---

Constructor & Destructor Documentation

xmog_int::xmog_int (  xmog_java_array *  _ref, jint  _index )

Creates an instance that acts as a proxy for an element of an int array. Parameters: _ref  a pointer to an array proxy element. _index  the index of the element.

xmog_int::xmog_int (  xmog_java_ref *  _clazz_ref_array, xmog_java_dynamic *  _dynamic, xmog_flags  _flags = 0 )

Creates an instance that acts as a proxy for an indirect element of int type. Parameters: _clazz_ref_array  a pointer to the owner of the primitive value. _dynamic  the algorithm to access the value. _flags  additional processing arguments.

---

Member Function Documentation

jint xmog_int::get (  xmog_localenv *  env = NULL, bool  readThrough = false )  const

Returns the value of a int proxy instance. This method takes two optional arguments that can be used to improve overall performance or force a read from the Java side even if a cached value is available. Parameters: env  a local environment pointer. May be NULL. readThrough  true if the value should be read from the Java side unconditionally, false if a cached value should be used if available. This flag is ignored if the instance does not use caching or if it does not yet have a cached value.

xmog_int& xmog_int::operator &= (  jint   )

The bitwise-AND assignment operator from the jint type. This operator allows the use of proxy instances of this type in any place where the compiler expects a primitive jint lhs-value. You can achieve better performance by using the set(jbyte,xmog_localenv*,bool) method with the proper arguments.

jint xmog_int::operator * (   )  const

The dereference operator converts to the jint type. This operator is declared to support array iterators.

xmog_int& xmog_int::operator *= (  jint   )

The multiplicative assignment operator. This operator allows the use of proxy instances of this type in any place where the compiler expects a primitive jint lhs-value. You can achieve better performance by using the set(jbyte,xmog_localenv*,bool) method with the proper arguments.

xmog_int::operator jint (   )  const

A conversion operator to the int type. This operator allows the use of proxy instances of this type in any place where the compiler expects a primitive jint rhs-value. You can achieve better performance by using the get(xmog_localenv*,bool) method with the proper arguments.

xmog_int& xmog_int::operator%= (  jint   )

The modulo assignment operator from the jint type. This operator allows the use of proxy instances of this type in any place where the compiler expects a primitive jint lhs-value. You can achieve better performance by using the set(jbyte,xmog_localenv*,bool) method with the proper arguments.

xmog_int& xmog_int::operator+= (  jint   )

The additive assignment operator. This operator allows the use of proxy instances of this type in any place where the compiler expects a primitive jint lhs-value. You can achieve better performance by using the set(jbyte,xmog_localenv*,bool) method with the proper arguments.

xmog_int& xmog_int::operator-= (  jint   )

The subtractive assignment operator. This operator allows the use of proxy instances of this type in any place where the compiler expects a primitive jint lhs-value. You can achieve better performance by using the set(jbyte,xmog_localenv*,bool) method with the proper arguments.

xmog_int& xmog_int::operator/= (  jint   )

The divisive assignment operator. This operator allows the use of proxy instances of this type in any place where the compiler expects a primitive jint lhs-value. You can achieve better performance by using the set(jbyte,xmog_localenv*,bool) method with the proper arguments.

xmog_int& xmog_int::operator<<= (  int   )

The bitwise-shift LEFT assignment operator. This operator allows the use of proxy instances of this type in any place where the compiler expects a primitive jint lhs-value. You can achieve better performance by using the set(jbyte,xmog_localenv*,bool) method with the proper arguments.

xmog_int& xmog_int::operator= (  jint   )

An assignment operator from the int type. This operator allows the use of proxy instances of this type in any place where the compiler expects a primitive jint lhs-value. You can achieve better performance by using the set(jint,xmog_localenv*,bool) method with the proper arguments.

xmog_int& xmog_int::operator>>= (  int   )

The bitwise-shift RIGHT assignment operator. This operator allows the use of proxy instances of this type in any place where the compiler expects a primitive jint lhs-value. You can achieve better performance by using the set(jbyte,xmog_localenv*,bool) method with the proper arguments.

xmog_int& xmog_int::operator^= (  jint   )

The bitwise-XOR assignment operator from the jint type. This operator allows the use of proxy instances of this type in any place where the compiler expects a primitive jint lhs-value. You can achieve better performance by using the set(jbyte,xmog_localenv*,bool) method with the proper arguments.

xmog_int& xmog_int::operator|= (  jint   )

The bitwise-OR assignment operator from the jint type. This operator allows the use of proxy instances of this type in any place where the compiler expects a primitive jint lhs-value. You can achieve better performance by using the set(jbyte,xmog_localenv*,bool) method with the proper arguments.

void xmog_int::set (  jint  i, xmog_localenv *  env = NULL, bool  writeThrough = false )

Sets the value of a int proxy. This method takes two optional arguments that can be used to improve overall performance or force a write to the Java side even if the CACHE_LAZY_WRITE policy is in effect for this instance. Parameters: i  the new value. env  a local environment pointer. May be NULL. writeThrough  true if the value should be written to the Java side unconditionally, false if only the cached value should be updated. This flag is ignored if the instance does not use caching.

---

The documentation for this class was generated from the following file:

• xmog_java_field.h

---