xmog_java_element Class Reference
[Arrays]

A class implementing the xmog_java_dynamic interface for accessing Java array elements via JNI or Codemesh's remoting protocol. More...

#include <xmog_java_array.h>

Inheritance diagram for xmog_java_element:

[legend]Collaboration diagram for xmog_java_element:

[legend]List of all members.

Public Member Functions
	xmog_java_element ()
	The default constructor.
	~xmog_java_element ()
	Removes the field instance from the declaring class' list of fields.
virtual bool	get_bool (xmog_base *obj, xmog_java_values *args=NULL, xmog_localenv *env=NULL, xmog_flags flags=0)
	Returns the value of a boolean array element.
virtual jboolean	get_jboolean (xmog_base *obj, xmog_java_values *args=NULL, xmog_localenv *env=NULL, xmog_flags flags=0)
	Returns the value of a boolean array element.
virtual jbyte	get_byte (xmog_base *obj, xmog_java_values *args=NULL, xmog_localenv *env=NULL, xmog_flags flags=0)
	Returns the value of a byte array element.
virtual jchar	get_char (xmog_base *obj, xmog_java_values *args=NULL, xmog_localenv *env=NULL, xmog_flags flags=0)
	Returns the value of a char array element.
virtual jdouble	get_double (xmog_base *obj, xmog_java_values *args=NULL, xmog_localenv *env=NULL, xmog_flags flags=0)
	Returns the value of a double array element.
virtual jfloat	get_float (xmog_base *obj, xmog_java_values *args=NULL, xmog_localenv *env=NULL, xmog_flags flags=0)
	Returns the value of a float array element.
virtual jint	get_int (xmog_base *obj, xmog_java_values *args=NULL, xmog_localenv *env=NULL, xmog_flags flags=0)
	Returns the value of an int array element.
virtual jlong	get_long (xmog_base *obj, xmog_java_values *args=NULL, xmog_localenv *env=NULL, xmog_flags flags=0)
	Returns the value of a long array element.
virtual jshort	get_short (xmog_base *obj, xmog_java_values *args=NULL, xmog_localenv *env=NULL, xmog_flags flags=0)
	Returns the value of a short array element.
virtual jobject	get_jobject (xmog_base *obj, xmog_java_values *args=NULL, xmog_localenv *env=NULL, xmog_flags flags=xmog_base::GLOBAL)
	Returns the value of an object array element.
virtual void	get_void (xmog_base *obj, xmog_java_values *args=NULL, xmog_localenv *env=NULL, xmog_flags flags=0)
	Not implemented for this type.
virtual void	set_bool (xmog_base *obj, bool b, xmog_localenv *env=NULL)
	Sets the value of a boolean array element.
virtual void	set_jboolean (xmog_base *obj, jboolean b, xmog_localenv *env=NULL)
	Sets the value of a boolean array element.
virtual void	set_byte (xmog_base *obj, jbyte b, xmog_localenv *env=NULL)
	Sets the value of a byte array element.
virtual void	set_char (xmog_base *obj, jchar ch, xmog_localenv *env=NULL)
	Sets the value of a char array element.
virtual void	set_double (xmog_base *obj, jdouble d, xmog_localenv *env=NULL)
	Sets the value of a double array element.
virtual void	set_float (xmog_base *obj, jfloat f, xmog_localenv *env=NULL)
	Sets the value of a float array element.
virtual void	set_int (xmog_base *obj, jint i, xmog_localenv *env=NULL)
	Sets the value of an int array element.
virtual void	set_long (xmog_base *obj, jlong l, xmog_localenv *env=NULL)
	Sets the value of a long array element.
virtual void	set_short (xmog_base *obj, jshort sh, xmog_localenv *env=NULL)
	Sets the value of a short array element.
virtual void	set_jobject (xmog_base *obj, jobject o, xmog_localenv *env=NULL)
	Sets the value of an object array element.
Static Public Attributes
static xmog_java_element	theElement
	The single instance of this type that exists in the framework.

---

Detailed Description

A class implementing the xmog_java_dynamic interface for accessing Java array elements via JNI or Codemesh's remoting protocol.

This type is a specialization of the xmog_java_dynamic interface that knows how to get and set the elements of Java arrays. This type is a support type that is used by the actual wrapper type, for example xmog_bool. Array element proxy instances are created when the programmer uses the subscript operators on the array instance. That element instance is then used to provide access the underlying Java array element.

Only one instance of this type is ever needed because each concrete array type calls different methods based on its type.

You should never have to use this type explicitly; it is part of the runtime framework.

---

Member Function Documentation

virtual bool xmog_java_element::get_bool (  xmog_base *  obj, xmog_java_values *  args = NULL, xmog_localenv *  env = NULL, xmog_flags  flags = 0 )  [virtual]

Returns the value of a boolean array element. Parameters: obj  pointer to the owning array element. args  the element index is contained in the size field. env  the local environment used in this call. This value may be NULL. flags  the processing flags for the operation. The default value is 0. Implements xmog_java_dynamic.

virtual jbyte xmog_java_element::get_byte (  xmog_base *  obj, xmog_java_values *  args = NULL, xmog_localenv *  env = NULL, xmog_flags  flags = 0 )  [virtual]

Returns the value of a byte array element. Parameters: obj  pointer to the owning array element. args  the element index is contained in the size field. env  the local environment used in this call. This value may be NULL. flags  the processing flags for the operation. The default value is 0. Implements xmog_java_dynamic.

virtual jchar xmog_java_element::get_char (  xmog_base *  obj, xmog_java_values *  args = NULL, xmog_localenv *  env = NULL, xmog_flags  flags = 0 )  [virtual]

Returns the value of a char array element. Parameters: obj  pointer to the owning array element. args  the element index is contained in the size field. env  the local environment used in this call. This value may be NULL. flags  the processing flags for the operation. The default value is 0. Implements xmog_java_dynamic.

virtual jdouble xmog_java_element::get_double (  xmog_base *  obj, xmog_java_values *  args = NULL, xmog_localenv *  env = NULL, xmog_flags  flags = 0 )  [virtual]

Returns the value of a double array element. Parameters: obj  pointer to the owning array element. args  the element index is contained in the size field. env  the local environment used in this call. This value may be NULL. flags  the processing flags for the operation. The default value is 0. Implements xmog_java_dynamic.

virtual jfloat xmog_java_element::get_float (  xmog_base *  obj, xmog_java_values *  args = NULL, xmog_localenv *  env = NULL, xmog_flags  flags = 0 )  [virtual]

Returns the value of a float array element. Parameters: obj  pointer to the owning array element. args  the element index is contained in the size field. env  the local environment used in this call. This value may be NULL. flags  the processing flags for the operation. The default value is 0. Implements xmog_java_dynamic.

virtual jint xmog_java_element::get_int (  xmog_base *  obj, xmog_java_values *  args = NULL, xmog_localenv *  env = NULL, xmog_flags  flags = 0 )  [virtual]

Returns the value of an int array element. Parameters: obj  pointer to the owning array element. args  the element index is contained in the size field. env  the local environment used in this call. This value may be NULL. flags  the processing flags for the operation. The default value is 0. Implements xmog_java_dynamic.

virtual jboolean xmog_java_element::get_jboolean (  xmog_base *  obj, xmog_java_values *  args = NULL, xmog_localenv *  env = NULL, xmog_flags  flags = 0 )  [virtual]

Returns the value of a boolean array element. Parameters: obj  pointer to the owning array element. args  the element index is contained in the size field. env  the local environment used in this call. This value may be NULL. flags  the processing flags for the operation. The default value is 0. Implements xmog_java_dynamic.

virtual jobject xmog_java_element::get_jobject (  xmog_base *  obj, xmog_java_values *  args = NULL, xmog_localenv *  env = NULL, xmog_flags  flags = xmog_base::GLOBAL )  [virtual]

Returns the value of an object array element. Parameters: obj  pointer to the owning array element. args  the element index is contained in the size field. env  the local environment used in this call. This value may be NULL. flags  the processing flags for the operation. The default value is xmog_base::GLOBAL. Implements xmog_java_dynamic.

virtual jlong xmog_java_element::get_long (  xmog_base *  obj, xmog_java_values *  args = NULL, xmog_localenv *  env = NULL, xmog_flags  flags = 0 )  [virtual]

Returns the value of a long array element. Parameters: obj  pointer to the owning array element. args  the element index is contained in the size field. env  the local environment used in this call. This value may be NULL. flags  the processing flags for the operation. The default value is 0. Implements xmog_java_dynamic.

virtual jshort xmog_java_element::get_short (  xmog_base *  obj, xmog_java_values *  args = NULL, xmog_localenv *  env = NULL, xmog_flags  flags = 0 )  [virtual]

Returns the value of a short array element. Parameters: obj  pointer to the owning array element. args  the element index is contained in the size field. env  the local environment used in this call. This value may be NULL. flags  the processing flags for the operation. The default value is 0. Implements xmog_java_dynamic.

virtual void xmog_java_element::get_void (  xmog_base *  obj, xmog_java_values *  args = NULL, xmog_localenv *  env = NULL, xmog_flags  flags = 0 )  [virtual]

Not implemented for this type. There are no array elements of type void. Parameters: obj  unused. args  unused. env  unused. flags  unused. Implements xmog_java_dynamic.

virtual void xmog_java_element::set_bool (  xmog_base *  obj, bool  b, xmog_localenv *  env = NULL )  [virtual]

Sets the value of a boolean array element. Parameters: obj  pointer to the owning array element. b  the new value of the array element. env  the local environment used in this call. This value may be NULL. Implements xmog_java_dynamic.

virtual void xmog_java_element::set_byte (  xmog_base *  obj, jbyte  b, xmog_localenv *  env = NULL )  [virtual]

Sets the value of a byte array element. Parameters: obj  pointer to the owning array element. b  the new value of the array element. env  the local environment used in this call. This value may be NULL. Implements xmog_java_dynamic.

virtual void xmog_java_element::set_char (  xmog_base *  obj, jchar  ch, xmog_localenv *  env = NULL )  [virtual]

Sets the value of a char array element. Parameters: obj  pointer to the owning array element. ch  the new value of the array element. env  the local environment used in this call. This value may be NULL. Implements xmog_java_dynamic.

virtual void xmog_java_element::set_double (  xmog_base *  obj, jdouble  d, xmog_localenv *  env = NULL )  [virtual]

Sets the value of a double array element. Parameters: obj  pointer to the owning array element. d  the new value of the array element. env  the local environment used in this call. This value may be NULL. Implements xmog_java_dynamic.

virtual void xmog_java_element::set_float (  xmog_base *  obj, jfloat  f, xmog_localenv *  env = NULL )  [virtual]

Sets the value of a float array element. Parameters: obj  pointer to the owning array element. f  the new value of the array element. env  the local environment used in this call. This value may be NULL. Implements xmog_java_dynamic.

virtual void xmog_java_element::set_int (  xmog_base *  obj, jint  i, xmog_localenv *  env = NULL )  [virtual]

Sets the value of an int array element. Parameters: obj  pointer to the owning array element. i  the new value of the array element. env  the local environment used in this call. This value may be NULL. Implements xmog_java_dynamic.

virtual void xmog_java_element::set_jboolean (  xmog_base *  obj, jboolean  b, xmog_localenv *  env = NULL )  [virtual]

Sets the value of a boolean array element. Parameters: obj  pointer to the owning array element. b  the new value of the array element. env  the local environment used in this call. This value may be NULL. Implements xmog_java_dynamic.

virtual void xmog_java_element::set_jobject (  xmog_base *  obj, jobject  o, xmog_localenv *  env = NULL )  [virtual]

Sets the value of an object array element. Parameters: obj  pointer to the owning array element. o  the new value of the array element. env  the local environment used in this call. This value may be NULL. Implements xmog_java_dynamic.

virtual void xmog_java_element::set_long (  xmog_base *  obj, jlong  l, xmog_localenv *  env = NULL )  [virtual]

Sets the value of a long array element. Parameters: obj  pointer to the owning array element. l  the new value of the array element. env  the local environment used in this call. This value may be NULL. Implements xmog_java_dynamic.

virtual void xmog_java_element::set_short (  xmog_base *  obj, jshort  sh, xmog_localenv *  env = NULL )  [virtual]

Sets the value of a short array element. Parameters: obj  pointer to the owning array element. sh  the new value of the array element. env  the local environment used in this call. This value may be NULL. Implements xmog_java_dynamic.

---

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

• xmog_java_array.h

---