indexing
	description: "Access to Java classes. Static methods and attributes are accessed via this class"
	legal: "See notice at end of class."
	status: "See notice at end of class."
	date: "$Date: 2006-01-22 18:25:44 -0800 (Sun, 22 Jan 2006) $"
	revision: "$Revision: 56675 $"

class interface
	JAVA_CLASS

create {JNI_ENVIRONMENT}
	make (jclass_id: POINTER)
			-- Create a new instance of Java class give "jclass_id"
		ensure then
			java_class_id /= default_pointer
			name /= Void

feature -- Access

	generating_type: STRING_8
			-- Name of current object's generating type
			-- (type of which it is a direct instance)
			-- (from ANY)

	generator: STRING_8
			-- Name of current object's generating class
			-- (base class of the type of which it is a direct instance)
			-- (from ANY)

	java_class_id: POINTER
			-- Reference to java object.

	jni: JNI_ENVIRONMENT
			-- Standard JNI enviroment. It uses value of
			-- CLASS_PATH environment variable to initialize JVM.
			-- (from SHARED_JNI_ENVIRONMENT)
		ensure -- from SHARED_JNI_ENVIRONMENT
			jni_not_void: Result /= Void

	name: STRING_8
			-- Name of current class.
	
feature -- Comparison

	frozen deep_equal (some: ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' either both void
			-- or attached to isomorphic object structures?
			-- (from ANY)
		ensure -- from ANY
			shallow_implies_deep: standard_equal (some, other) implies Result
			both_or_none_void: (some = Void) implies (Result = (other = Void))
			same_type: (Result and (some /= Void)) implies some.same_type (other)
			symmetric: Result implies deep_equal (other, some)

	frozen equal (some: ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' either both void or attached
			-- to objects considered equal?
			-- (from ANY)
		ensure -- from ANY
			definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.is_equal (other))

	is_equal (other: like Current): BOOLEAN
			-- Is `other' attached to an object considered
			-- equal to current object?
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			symmetric: Result implies other.is_equal (Current)
			consistent: standard_is_equal (other) implies Result

	frozen standard_equal (some: ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' either both void or attached to
			-- field-by-field identical objects of the same type?
			-- Always uses default object comparison criterion.
			-- (from ANY)
		ensure -- from ANY
			definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.standard_is_equal (other))

	frozen standard_is_equal (other: like Current): BOOLEAN
			-- Is `other' attached to an object of the same type
			-- as current object, and field-by-field identical to it?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			same_type: Result implies same_type (other)
			symmetric: Result implies other.standard_is_equal (Current)
	
feature -- Status report

	conforms_to (other: ANY): BOOLEAN
			-- Does type of current object conform to type
			-- of `other' (as per Eiffel: The Language, chapter 13)?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void

	exists: BOOLEAN
			-- Is Current java object alive?

	same_type (other: ANY): BOOLEAN
			-- Is type of current object identical to type of `other'?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			definition: Result = (conforms_to (other) and other.conforms_to (Current))
	
feature -- Duplication

	copy (other: like Current)
			-- Update current object using fields of object attached
			-- to `other', so as to yield equal objects.
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
			type_identity: same_type (other)
		ensure -- from ANY
			is_equal: is_equal (other)

	frozen deep_copy (other: like Current)
			-- Effect equivalent to that of:
			--		copy (`other' . deep_twin)
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			deep_equal: deep_equal (Current, other)

	frozen deep_twin: like Current
			-- New object structure recursively duplicated from Current.
			-- (from ANY)
		ensure -- from ANY
			deep_equal: deep_equal (Current, Result)

	frozen standard_copy (other: like Current)
			-- Copy every field of `other' onto corresponding field
			-- of current object.
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
			type_identity: same_type (other)
		ensure -- from ANY
			is_standard_equal: standard_is_equal (other)

	frozen standard_twin: like Current
			-- New object field-by-field identical to `other'.
			-- Always uses default copying semantics.
			-- (from ANY)
		ensure -- from ANY
			standard_twin_not_void: Result /= Void
			equal: standard_equal (Result, Current)

	frozen twin: like Current
			-- New object equal to `Current'
			-- twin calls copy; to change copying/twining semantics, redefine copy.
			-- (from ANY)
		ensure -- from ANY
			twin_not_void: Result /= Void
			is_equal: Result.is_equal (Current)
	
feature -- Basic operations

	frozen default: like Current
			-- Default value of object's type
			-- (from ANY)

	frozen default_pointer: POINTER
			-- Default value of type `POINTER'
			-- (Avoid the need to write `p'.default for
			-- some `p' of type `POINTER'.)
			-- (from ANY)

	default_rescue
			-- Process exception for routines with no Rescue clause.
			-- (Default: do nothing.)
			-- (from ANY)

	frozen do_nothing
			-- Execute a null action.
			-- (from ANY)
	
feature -- Access to static attributes

	boolean_attribute (fid: POINTER): BOOLEAN
			-- Access to a boolean attribute
		require -- from JAVA_ENTITY
			fid_not_null: fid /= default_pointer

	byte_attribute (fid: POINTER): INTEGER_8
			-- Access to a 'byte' attribute, returns a INTEGER_8
		require -- from JAVA_ENTITY
			fid_not_null: fid /= default_pointer

	char_attribute (fid: POINTER): CHARACTER_8
			-- Access to a 'char' attribute
		require -- from JAVA_ENTITY
			fid_not_null: fid /= default_pointer

	double_attribute (fid: POINTER): REAL_64
			-- Access to a double attribute
		require -- from JAVA_ENTITY
			fid_not_null: fid /= default_pointer

	float_attribute (fid: POINTER): REAL_32
			-- Access to a 'float' attribute, returns a REAL
		require -- from JAVA_ENTITY
			fid_not_null: fid /= default_pointer

	integer_attribute (fid: POINTER): INTEGER_32
			-- get a value of an integer static field
		require -- from JAVA_ENTITY
			fid_not_null: fid /= default_pointer

	long_attribute (fid: POINTER): INTEGER_64
			-- Access to a 'short' attribute, returns a INTEGER_64
		require -- from JAVA_ENTITY
			fid_not_null: fid /= default_pointer

	object_attribute (fid: POINTER): JAVA_OBJECT
			-- get the value of OBJECT static field
		require -- from JAVA_ENTITY
			fid_not_null: fid /= default_pointer

	short_attribute (fid: POINTER): INTEGER_16
			-- Access to a 'short' attribute, returns a INTEGER_16
		require -- from JAVA_ENTITY
			fid_not_null: fid /= default_pointer

	string_attribute (fid: POINTER): STRING_8
			-- get the value of STRING static field
		require -- from JAVA_ENTITY
			fid_not_null: fid /= default_pointer
	
feature -- Output

	io: STD_FILES
			-- Handle to standard file setup
			-- (from ANY)

	out: STRING_8
			-- New string containing terse printable representation
			-- of current object
			-- Was declared in ANY as synonym of tagged_out.
			-- (from ANY)

	print (some: ANY)
			-- Write terse external representation of `some'
			-- on standard output.
			-- (from ANY)

	frozen tagged_out: STRING_8
			-- New string containing terse printable representation
			-- of current object
			-- Was declared in ANY as synonym of out.
			-- (from ANY)
	
feature -- Platform

	operating_environment: OPERATING_ENVIRONMENT
			-- Objects available from the operating system
			-- (from ANY)
	
feature -- Reflection

	field_id (fname: STRING_8; sig: STRING_8): POINTER
			-- Get the java field id of a static field, used to set/get this field
		require -- from JAVA_ENTITY
			attribute_name_not_void: fname /= Void
			attribute_name_not_empty: not fname.is_empty
			signature_not_void: sig /= Void
			signature_not_empty: not sig.is_empty
		require else
			(fname /= Void) and (sig /= Void)

	method_id (mname: STRING_8; sig: STRING_8): POINTER
			-- Return "method_id" for a static method with "mname" and 
			-- signature "sig" that belongs to this class.
		require -- from JAVA_ENTITY
			feature_name_not_void: mname /= Void
			feature_name_not_empty: not mname.is_empty
			signature_not_void: sig /= Void
			signature_not_empty: not sig.is_empty
		ensure -- from JAVA_ENTITY
			method_exists: Result /= default_pointer
	
feature -- Setting static attributes

	set_boolean_attribute (fid: POINTER; value: BOOLEAN)
			-- Set a 'boolean' attribute to 'value'
		require -- from JAVA_ENTITY
			fid_not_null: fid /= default_pointer
		ensure -- from JAVA_ENTITY
			boolean_attribute_set: boolean_attribute (fid) = value

	set_byte_attribute (fid: POINTER; value: INTEGER_8)
			-- Set a 'byte' attribute to 'value'
		require -- from JAVA_ENTITY
			fid_not_null: fid /= default_pointer
		ensure -- from JAVA_ENTITY
			byte_attribute_set: byte_attribute (fid) = value

	set_char_attribute (fid: POINTER; value: CHARACTER_8)
			-- Set a 'char' attribute to 'value'
		require -- from JAVA_ENTITY
			fid_not_null: fid /= default_pointer
		ensure -- from JAVA_ENTITY
			char_attribute_set: char_attribute (fid) = value

	set_double_attribute (fid: POINTER; value: REAL_64)
			-- Set a 'double' attribute to 'value'
		require -- from JAVA_ENTITY
			fid_not_null: fid /= default_pointer
		ensure -- from JAVA_ENTITY
			double_attribute_set: double_attribute (fid) = value

	set_float_attribute (fid: POINTER; value: REAL_32)
			-- Set a 'float' attribute to 'value'
		require -- from JAVA_ENTITY
			fid_not_null: fid /= default_pointer
		ensure -- from JAVA_ENTITY
			float_attribute_set: float_attribute (fid) = value

	set_integer_attribute (fid: POINTER; value: INTEGER_32)
			-- Set an 'integer' attribute to 'value'
		require -- from JAVA_ENTITY
			fid_not_null: fid /= default_pointer
		ensure -- from JAVA_ENTITY
			integer_attribute_set: integer_attribute (fid) = value

	set_long_attribute (fid: POINTER; value: INTEGER_64)
			-- Set a 'short' attribute to 'value'
		require -- from JAVA_ENTITY
			fid_not_null: fid /= default_pointer
		ensure -- from JAVA_ENTITY
			long_attribute_set: long_attribute (fid) = value

	set_object_attribute (fid: POINTER; value: JAVA_OBJECT)
			-- Set a java object attribute to 'value'
		require -- from JAVA_ENTITY
			fid_not_null: fid /= default_pointer
		ensure -- from JAVA_ENTITY
			object_attribute_set: object_attribute (fid) = value

	set_short_attribute (fid: POINTER; value: INTEGER_16)
			-- Set a 'short' attribute to 'value'
		require -- from JAVA_ENTITY
			fid_not_null: fid /= default_pointer
		ensure -- from JAVA_ENTITY
			short_attribute_set: short_attribute (fid) = value

	set_string_attribute (fid: POINTER; value: STRING_8)
			-- Set a 'String' attribute to 'value'
		require -- from JAVA_ENTITY
			fid_not_null: fid /= default_pointer
		ensure -- from JAVA_ENTITY
			string_attribute_set: equal (string_attribute (fid), value)
	
feature -- calling static methods

	boolean_method (mid: POINTER; args: JAVA_ARGS): BOOLEAN
			-- Call a static function that returns a BOOLEAN.
		require -- from JAVA_ENTITY
			mid_not_null: mid /= default_pointer

	byte_method (mid: POINTER; args: JAVA_ARGS): INTEGER_8
			-- Call a static function that returns a byte 
			-- (represented as CHARACTER in Eiffel)
		require -- from JAVA_ENTITY
			mid_not_null: mid /= default_pointer

	char_method (mid: POINTER; args: JAVA_ARGS): CHARACTER_8
			-- Call a static function that returns a CHARACTER.
		require -- from JAVA_ENTITY
			mid_not_null: mid /= default_pointer

	double_method (mid: POINTER; args: JAVA_ARGS): REAL_64
			-- Call a static function that returns a DOUBLE.
		require -- from JAVA_ENTITY
			mid_not_null: mid /= default_pointer

	float_method (mid: POINTER; args: JAVA_ARGS): REAL_32
			-- Call a static function that returns a REAL.
		require -- from JAVA_ENTITY
			mid_not_null: mid /= default_pointer

	integer_method (mid: POINTER; args: JAVA_ARGS): INTEGER_32
			-- Call a static function that returns an INTEGER.
		require -- from JAVA_ENTITY
			mid_not_null: mid /= default_pointer

	long_method (mid: POINTER; args: JAVA_ARGS): INTEGER_64
			-- Call a static function that returns a long 
			-- (represented as INTEGER_64 in Eiffel)
		require -- from JAVA_ENTITY
			mid_not_null: mid /= default_pointer

	object_method (lmethod_id: POINTER; args: JAVA_ARGS): JAVA_OBJECT
			-- Call a static function that returns a JAVA_OBJECT. An 
			-- Eiffl proxy object is returned.
		require -- from JAVA_ENTITY
			mid_not_null: lmethod_id /= default_pointer

	short_method (mid: POINTER; args: JAVA_ARGS): INTEGER_16
			-- Call a static function that returns a short 
			-- (represented as INTEGER in Eiffel)
		require -- from JAVA_ENTITY
			mid_not_null: mid /= default_pointer

	string_method (lmethod_id: POINTER; args: JAVA_ARGS): STRING_8
			-- Call static routine that returns a string
		require -- from JAVA_ENTITY
			mid_not_null: lmethod_id /= default_pointer

	void_method (lmethod_id: POINTER; args: JAVA_ARGS)
			-- call static method with specific ID, passing arguments
		require -- from JAVA_ENTITY
			mid_not_null: lmethod_id /= default_pointer
	
invariant
		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)

indexing
	copyright: "Copyright (c) 1984-2006, Eiffel Software and others"
	license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
	source: "[
		Eiffel Software
		356 Storke Road, Goleta, CA 93117 USA
		Telephone 805-685-1006, Fax 805-685-6869
		Website http://www.eiffel.com
		Customer support http://support.eiffel.com
	]"

end -- class JAVA_CLASS