Automatic generation produced by ISE Eiffel
note description: "This class gives Eiffel access to Java objects. You can use it directly or inherit from to and create a more convienient Eiffel class that makes the Java object look like an Eiffel object" legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2009-02-24 14:44:31 -0900 (Tue, 24 Feb 2009) $" revision: "$Revision: 77298 $" class interface JAVA_OBJECT create create_instance (my_cls: JAVA_CLASS; sig: detachable STRING_8; args: detachable JAVA_ARGS) -- Create an instance of the class by calling the -- constructor with the specified arguments. If "sig" is -- void then we assume that the contructor has no -- arguments. In that case "args" can be void require class_valid: my_cls /= Void sig_and_args_consistent: (sig = Void) implies (args = Void) ensure created: java_object_id /= default_pointer make_from_pointer (jobject: POINTER) -- Create an Eiffel proxy, give a pointer to a Java object -- (Java object already exists) require valid_java_id: jobject /= default_pointer feature -- Initialization create_instance (my_cls: JAVA_CLASS; sig: detachable STRING_8; args: detachable JAVA_ARGS) -- Create an instance of the class by calling the -- constructor with the specified arguments. If "sig" is -- void then we assume that the contructor has no -- arguments. In that case "args" can be void require class_valid: my_cls /= Void sig_and_args_consistent: (sig = Void) implies (args = Void) ensure created: java_object_id /= default_pointer make_from_pointer (jobject: POINTER) -- Create an Eiffel proxy, give a pointer to a Java object -- (Java object already exists) require valid_java_id: jobject /= default_pointer feature -- Access generating_type: TYPE [detachable JAVA_OBJECT] -- Type of current object -- (type of which it is a direct instance) -- (from ANY) ensure -- from ANY generating_type_not_void: Result /= Void generator: STRING_8 -- Name of current object's generating class -- (base class of the type of which it is a direct instance) -- (from ANY) ensure -- from ANY generator_not_void: Result /= Void generator_not_empty: not Result.is_empty java_object_id: POINTER -- Reference to java object. jclass: JAVA_CLASS -- Associated java class. 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 feature -- Comparison frozen deep_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void -- or attached to isomorphic object structures? -- (from ANY) ensure -- from ANY instance_free: class shallow_implies_deep: standard_equal (a, b) implies Result both_or_none_void: (a = Void) implies (Result = (b = Void)) same_type: (Result and (a /= Void)) implies (b /= Void and then a.same_type (b)) symmetric: Result implies deep_equal (b, a) frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached -- to objects considered equal? -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b)) frozen is_deep_equal alias "≡≡≡" (other: JAVA_OBJECT): BOOLEAN -- Are Current and other attached to isomorphic object structures? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY shallow_implies_deep: standard_is_equal (other) implies Result same_type: Result implies same_type (other) symmetric: Result implies other.is_deep_equal (Current) 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 ~ Current consistent: standard_is_equal (other) implies Result frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b 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 instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b)) frozen standard_is_equal alias "≜" (other: JAVA_OBJECT): 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: JAVA_OBJECT) -- 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: Current ~ other frozen deep_copy (other: JAVA_OBJECT) -- 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: JAVA_OBJECT -- New object structure recursively duplicated from Current. -- (from ANY) ensure -- from ANY deep_twin_not_void: Result /= Void deep_equal: deep_equal (Current, Result) frozen standard_copy (other: JAVA_OBJECT) -- 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: JAVA_OBJECT -- 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: JAVA_OBJECT -- New object equal to Current -- `twin` calls `copy`; to change copying/twinning semantics, redefine `copy`. -- (from ANY) ensure -- from ANY twin_not_void: Result /= Void is_equal: Result ~ Current feature -- Basic operations frozen default: detachable JAVA_OBJECT -- 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) ensure -- from ANY instance_free: class default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) frozen do_nothing -- Execute a null action. -- (from ANY) ensure -- from ANY instance_free: class feature -- 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 -- Access to an integer attribute require -- from JAVA_ENTITY fid_not_null: fid /= default_pointer long_attribute (fid: POINTER): INTEGER_64 -- Access to a 'long' attribute, returns a INTEGER_64 require -- from JAVA_ENTITY fid_not_null: fid /= default_pointer object_attribute (fid: POINTER): detachable JAVA_OBJECT -- Access to a java object attribute 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): detachable STRING_8 -- Access to a String attribute require -- from JAVA_ENTITY fid_not_null: fid /= default_pointer feature -- Attributes setting 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 value_not_void: value /= Void 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 value_not_void: value /= Void ensure -- from JAVA_ENTITY string_attribute_set: string_attribute (fid) ~ value feature -- Calls boolean_method (mid: POINTER; args: detachable JAVA_ARGS): BOOLEAN -- Call an instance function that returns a boolean require -- from JAVA_ENTITY mid_not_null: mid /= default_pointer byte_method (mid: POINTER; args: detachable JAVA_ARGS): INTEGER_8 -- Call an instance function that return a byte -- ( 8-bit integer (signed)), in Eiffel return -- a INTEGER_8 require -- from JAVA_ENTITY mid_not_null: mid /= default_pointer char_method (mid: POINTER; args: detachable JAVA_ARGS): CHARACTER_8 -- Call an instance function that returns a char require -- from JAVA_ENTITY mid_not_null: mid /= default_pointer double_method (mid: POINTER; args: detachable JAVA_ARGS): REAL_64 -- Call an instance function that returns a DOUBLE. require -- from JAVA_ENTITY mid_not_null: mid /= default_pointer float_method (mid: POINTER; args: detachable JAVA_ARGS): REAL_32 -- Call an instance function that returns a REAL. require -- from JAVA_ENTITY mid_not_null: mid /= default_pointer integer_method (mid: POINTER; args: detachable JAVA_ARGS): INTEGER_32 -- Call an instance function that returns an INTEGER. require -- from JAVA_ENTITY mid_not_null: mid /= default_pointer long_method (mid: POINTER; args: detachable JAVA_ARGS): INTEGER_64 -- Call an instance function that returns an Long. This -- function is not implemented. require -- from JAVA_ENTITY mid_not_null: mid /= default_pointer object_method (lmethod_id: POINTER; args: detachable JAVA_ARGS): detachable JAVA_OBJECT -- Call an instance function that returns a java object require -- from JAVA_ENTITY mid_not_null: lmethod_id /= default_pointer short_method (mid: POINTER; args: detachable JAVA_ARGS): INTEGER_16 -- Call an instance function that returns a Short (in -- Eiffel we still return an INTEGER). require -- from JAVA_ENTITY mid_not_null: mid /= default_pointer string_method (mid: POINTER; args: detachable JAVA_ARGS): detachable STRING_8 -- Call an instance function that returns a STRING. require -- from JAVA_ENTITY mid_not_null: mid /= default_pointer void_method (mid: POINTER; args: detachable JAVA_ARGS) -- Call a Java procedure with method_id "mid" and -- arguments "args. require -- from JAVA_ENTITY mid_not_null: mid /= default_pointer feature -- Output Io: STD_FILES -- Handle to standard file setup -- (from ANY) ensure -- from ANY instance_free: class io_not_void: Result /= Void out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY out_not_void: Result /= Void print (o: detachable ANY) -- Write terse external representation of o -- on standard output. -- (from ANY) ensure -- from ANY instance_free: class frozen tagged_out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY tagged_out_not_void: Result /= Void feature -- Platform Operating_environment: OPERATING_ENVIRONMENT -- Objects available from the operating system -- (from ANY) ensure -- from ANY instance_free: class operating_environment_not_void: Result /= Void feature -- Reflection field_id (lname: STRING_8; sig: STRING_8): POINTER -- Get the java field id used to set/get this field require -- from JAVA_ENTITY attribute_name_not_void: lname /= Void attribute_name_not_empty: not lname.is_empty signature_not_void: sig /= Void signature_not_empty: not sig.is_empty method_id (feature_name: STRING_8; signature: STRING_8): POINTER -- Find the method_id for feature_name with signature -- encoded by "signature" require -- from JAVA_ENTITY feature_name_not_void: feature_name /= Void feature_name_not_empty: not feature_name.is_empty signature_not_void: signature /= Void signature_not_empty: not signature.is_empty ensure -- from JAVA_ENTITY method_exists: Result /= default_pointer invariant valid_proxy: java_object_id /= default_pointer -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2009, Eiffel Software and others" license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)" source: "[ Eiffel Software 5949 Hollister Ave., 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_OBJECT -- Generated by Eiffel Studio --
For more details: eiffel.org