java::lang::Class

java::lang::Class Class Reference

Instances of the class Class represent classes and interfaces in a running Java application. More...

#include <java_lang_Class.h>

Inheritance diagram for java::lang::Class:

[legend]Collaboration diagram for java::lang::Class:

[legend]List of all members.


Public Types
enum	{ xmogDefaultFlags = xmog_base::GLOBAL, xmogMajorVersion = 3, xmogMinorVersion = 2, xmogPatchVersion = 9, xmogBuildNumber = 2047 }
typedef ::xmog_java_array_template< ::java::lang::Class >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::java::lang::Class > >	array2D
Public Member Functions
bool	desiredAssertionStatus (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the assertion status that would be assigned to this class if it were to be initialized at the time this method is invoked.
::xmog_java_array_template< ::java::lang::Class >	getClasses (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns an array containing `Class` objects representing all the public classes and interfaces that are members of the class represented by this `Class` object.
::java::lang::Class	getComponentType (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the `Class` representing the component type of an array.
::java::lang::reflect::Constructor	getConstructor (const ::xmog_java_array_template< ::java::lang::Class > &parameterTypes,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a `Constructor` object that reflects the specified public constructor of the class represented by this `Class` object.
::xmog_java_array_template< ::java::lang::reflect::Constructor >	getConstructors (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns an array containing `Constructor` objects reflecting all the public constructors of the class represented by this `Class` object.
::xmog_java_array_template< ::java::lang::Class >	getDeclaredClasses (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns an array of `Class` objects reflecting all the classes and interfaces declared as members of the class represented by this `Class` object.
::java::lang::reflect::Constructor	getDeclaredConstructor (const ::xmog_java_array_template< ::java::lang::Class > &parameterTypes,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a `Constructor` object that reflects the specified constructor of the class or interface represented by this `Class` object.
::xmog_java_array_template< ::java::lang::reflect::Constructor >	getDeclaredConstructors (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns an array of `Constructor` objects reflecting all the constructors declared by the class represented by this `Class` object.
::java::lang::reflect::Field	getDeclaredField (const ::java::lang::String &name,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a `Field` object that reflects the specified declared field of the class or interface represented by this `Class` object.
::xmog_java_array_template< ::java::lang::reflect::Field >	getDeclaredFields (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns an array of `Field` objects reflecting all the fields declared by the class or interface represented by this `Class` object.
::java::lang::reflect::Method	getDeclaredMethod (const ::java::lang::String &name, const ::xmog_java_array_template< ::java::lang::Class > &parameterTypes,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a `Method` object that reflects the specified declared method of the class or interface represented by this `Class` object.
::xmog_java_array_template< ::java::lang::reflect::Method >	getDeclaredMethods (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns an array of `Method` objects reflecting all the methods declared by the class or interface represented by this `Class` object.
::java::lang::Class	getDeclaringClass (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	If the class or interface represented by this `Class` object is a member of another class, returns the `Class` object representing the class in which it was declared.
::java::lang::reflect::Field	getField (const ::java::lang::String &name,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a `Field` object that reflects the specified public member field of the class or interface represented by this `Class` object.
::xmog_java_array_template< ::java::lang::reflect::Field >	getFields (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns an array containing `Field` objects reflecting all the accessible public fields of the class or interface represented by this `Class` object.
::xmog_java_array_template< ::java::lang::Class >	getInterfaces (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Determines the interfaces implemented by the class or interface represented by this object.
::java::lang::reflect::Method	getMethod (const ::java::lang::String &name, const ::xmog_java_array_template< ::java::lang::Class > &parameterTypes,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a `Method` object that reflects the specified public member method of the class or interface represented by this `Class` object.
::xmog_java_array_template< ::java::lang::reflect::Method >	getMethods (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns an array containing `Method` objects reflecting all the public member methods of the class or interface represented by this `Class` object, including those declared by the class or interface and and those inherited from superclasses and superinterfaces.
jint	getModifiers (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the Java language modifiers for this class or interface, encoded in an integer.
::java::lang::String	getName (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the name of the entity (class, interface, array class, primitive type, or void) represented by this `Class` object, as a `String`.
::java::io::InputStream	getResourceAsStream (const ::java::lang::String &name,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Finds a resource with a given name.
::xmog_java_array_template< ::java::lang::Object >	getSigners (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Gets the signers of this class.
::java::lang::Class	getSuperclass (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the `Class` representing the superclass of the entity (class, interface, primitive type or void) represented by this `Class`.
bool	isArray (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Determines if this `Class` object represents an array class.
bool	isAssignableFrom (const ::java::lang::Class &cls,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Determines if the class or interface represented by this `Class` object is either the same as, or is a superclass or superinterface of, the class or interface represented by the specified `Class` parameter.
bool	isInstance (const ::java::lang::Object &obj,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Determines if the specified `Object` is assignment-compatible with the object represented by this `Class`.
bool	isInterface (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Determines if the specified `Class` object represents an interface type.
bool	isPrimitive (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Determines if the specified `Class` object represents a primitive type.
::java::lang::Object	newInstance (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Creates a new instance of the class represented by this `Class` object.
::java::lang::String	toString (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Converts the object to a string.
Static Public Member Functions
::java::lang::Class	forName (const ::java::lang::String &className,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the `Class` object associated with the class or interface with the given string name.

Detailed Description

Instances of the class Class represent classes and interfaces in a running Java application.

Every array also belongs to a class that is reflected as a Class object that is shared by all arrays with the same element type and number of dimensions. The primitive Java types (boolean, byte, char, short, int, long, float, and double), and the keyword void are also represented as Class objects.

Class has no public constructor. Instead Class objects are constructed automatically by the Java Virtual Machine as classes are loaded and by calls to the defineClass method in the class loader.

The following example uses a Class object to print the class name of an object:

                 void printClassName(Object obj) {
                     System.out.println("The class of " + obj +
                                        " is " + obj.getClass().getName());
                 }

</blockquote>

It is also possible to get the Class object for a named type (or for void) using a class literal (JLS Section 15.8.2). For example:

                 System.out.println("The name of class Foo is: "+Foo.class.getName());

</blockquote>

Author:: unascribed

Member Function Documentation

bool java::lang::Class::desiredAssertionStatus ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Returns the assertion status that would be assigned to this class if it were to be initialized at the time this method is invoked.
If this class has had its assertion status set, the most recent setting will be returned; otherwise, if any package default assertion status pertains to this class, the most recent setting for the most specific pertinent package default assertion status is returned; otherwise, if this class is not a system class (i.e., it has a class loader) its class loader's default assertion status is returned; otherwise, the system class default assertion status is returned.
Few programmers will have any need for this method; it is provided for the benefit of the JRE itself. (It allows a class to determine at the time that it is initialized whether assertions should be enabled.) Note that this method is not guaranteed to return the actual assertion status that was (or will be) associated with the specified class when it was (or will be) initialized.

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the desired assertion status of the specified class.

::java::lang::Class java::lang::Class::forName ( const ::java::lang::String & className,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [static]

Returns the Class object associated with the class or interface with the given string name.
Invoking this method is equivalent to:
<blockquote>

Class.forName(className, true, currentLoader)

</blockquote>
where currentLoader denotes the defining class loader of the current class.
For example, the following code fragment returns the runtime Class descriptor for the class named java.lang.Thread:
<blockquote>

Class t = Class.forName("java.lang.Thread")

</blockquote>
A call to forName("X") causes the class named X to be initialized.

Parameters:

className the fully qualified name of the desired class.

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the Class object for the class with the specified name.

::xmog_java_array_template< ::java::lang::Class > java::lang::Class::getClasses ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Returns an array containing Class objects representing all the public classes and interfaces that are members of the class represented by this Class object.
This includes public class and interface members inherited from superclasses and public class and interface members declared by the class. This method returns an array of length 0 if this Class object has no public member classes or interfaces. This method also returns an array of length 0 if this Class object represents a primitive type, an array class, or void.
For this class and each of its superclasses, the following security checks are performed: If there is a security manager, the security manager's checkMemberAccess method is called with this and Member.PUBLIC as its arguments, where this is this class or the superclass whose members are being determined. If the class is in a package, then the security manager's checkPackageAccess method is also called with the package name as its argument. Either of these calls could result in a SecurityException.

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the array of Class objects representing the public members of this class

::java::lang::Class java::lang::Class::getComponentType ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Returns the Class representing the component type of an array.
If this class does not represent an array class this method returns null.

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the Class representing the component type of this class if this class is an array

::java::lang::reflect::Constructor java::lang::Class::getConstructor ( const ::xmog_java_array_template< ::java::lang::Class > & parameterTypes,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Returns a Constructor object that reflects the specified public constructor of the class represented by this Class object.
The parameterTypes parameter is an array of Class objects that identify the constructor's formal parameter types, in declared order.
The constructor to reflect is the public constructor of the class represented by this Class object whose formal parameter types match those specified by parameterTypes.
If there is a security manager, this method first calls the security manager's checkMemberAccess method with this and Member.PUBLIC as its arguments. If the class is in a package, then this method also calls the security manager's checkPackageAccess method with the package name as its argument. Either of these calls could result in a SecurityException.

Parameters:

parameterTypes the parameter array

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the Method object of the public constructor that matches the specified parameterTypes

::xmog_java_array_template< ::java::lang::reflect::Constructor > java::lang::Class::getConstructors ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Returns an array containing Constructor objects reflecting all the public constructors of the class represented by this Class object.
An array of length 0 is returned if the class has no public constructors, or if the class is an array class, or if the class reflects a primitive type or void.
If there is a security manager, this method first calls the security manager's checkMemberAccess method with this and Member.PUBLIC as its arguments. If the class is in a package, then this method also calls the security manager's checkPackageAccess method with the package name as its argument. Either of these calls could result in a SecurityException.

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the array containing Method objects for all the declared public constructors of this class matches the specified parameterTypes

::xmog_java_array_template< ::java::lang::Class > java::lang::Class::getDeclaredClasses ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Returns an array of Class objects reflecting all the classes and interfaces declared as members of the class represented by this Class object.
This includes public, protected, default (package) access, and private classes and interfaces declared by the class, but excludes inherited classes and interfaces. This method returns an array of length 0 if the class declares no classes or interfaces as members, or if this Class object represents a primitive type, an array class, or void.
If there is a security manager, this method first calls the security manager's checkMemberAccess method with this and Member.DECLARED as its arguments. If the class is in a package, then this method also calls the security manager's checkPackageAccess method with the package name as its argument. Either of these calls could result in a SecurityException.

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the array of Class objects representing all the declared members of this class

::java::lang::reflect::Constructor java::lang::Class::getDeclaredConstructor ( const ::xmog_java_array_template< ::java::lang::Class > & parameterTypes,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Returns a Constructor object that reflects the specified constructor of the class or interface represented by this Class object.
The parameterTypes parameter is an array of Class objects that identify the constructor's formal parameter types, in declared order.
If there is a security manager, this method first calls the security manager's checkMemberAccess method with this and Member.DECLARED as its arguments. If the class is in a package, then this method also calls the security manager's checkPackageAccess method with the package name as its argument. Either of these calls could result in a SecurityException.

Parameters:

parameterTypes the parameter array

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
The Method object for the constructor with the specified parameter list

::xmog_java_array_template< ::java::lang::reflect::Constructor > java::lang::Class::getDeclaredConstructors ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Returns an array of Constructor objects reflecting all the constructors declared by the class represented by this Class object.
These are public, protected, default (package) access, and private constructors. The elements in the array returned are not sorted and are not in any particular order. If the class has a default constructor, it is included in the returned array. This method returns an array of length 0 if this Class object represents an interface, a primitive type, an array class, or void.
See The Java Language Specification, section 8.2.
If there is a security manager, this method first calls the security manager's checkMemberAccess method with this and Member.DECLARED as its arguments. If the class is in a package, then this method also calls the security manager's checkPackageAccess method with the package name as its argument. Either of these calls could result in a SecurityException.

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the array of Method objects representing all the declared constructors of this class

::java::lang::reflect::Field java::lang::Class::getDeclaredField ( const ::java::lang::String & name,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Returns a Field object that reflects the specified declared field of the class or interface represented by this Class object.
The name parameter is a String that specifies the simple name of the desired field. Note that this method will not reflect the length field of an array class.
If there is a security manager, this method first calls the security manager's checkMemberAccess method with this and Member.DECLARED as its arguments. If the class is in a package, then this method also calls the security manager's checkPackageAccess method with the package name as its argument. Either of these calls could result in a SecurityException.

Parameters:

name the name of the field

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the Field object for the specified field in this class

::xmog_java_array_template< ::java::lang::reflect::Field > java::lang::Class::getDeclaredFields ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Returns an array of Field objects reflecting all the fields declared by the class or interface represented by this Class object.
This includes public, protected, default (package) access, and private fields, but excludes inherited fields. The elements in the array returned are not sorted and are not in any particular order. This method returns an array of length 0 if the class or interface declares no fields, or if this Class object represents a primitive type, an array class, or void.
See The Java Language Specification, sections 8.2 and 8.3.
If there is a security manager, this method first calls the security manager's checkMemberAccess method with this and Member.DECLARED as its arguments. If the class is in a package, then this method also calls the security manager's checkPackageAccess method with the package name as its argument. Either of these calls could result in a SecurityException.

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the array of Field objects representing all the declared fields of this class

::java::lang::reflect::Method java::lang::Class::getDeclaredMethod ( const ::java::lang::String & name,

const ::xmog_java_array_template< ::java::lang::Class > & parameterTypes,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Returns a Method object that reflects the specified declared method of the class or interface represented by this Class object.
The name parameter is a String that specifies the simple name of the desired method, and the parameterTypes parameter is an array of Class objects that identify the method's formal parameter types, in declared order. If more than one method with the same parameter types is declared in a class, and one of these methods has a return type that is more specific than any of the others, that method is returned; otherwise one of the methods is chosen arbitrarily. If the name is "<init>"or "<clinit>" a NoSuchMethodException is raised.
If there is a security manager, this method first calls the security manager's checkMemberAccess method with this and Member.DECLARED as its arguments. If the class is in a package, then this method also calls the security manager's checkPackageAccess method with the package name as its argument. Either of these calls could result in a SecurityException.

Parameters:

name the name of the method

parameterTypes the parameter array

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the Method object for the method of this class matching the specified name and parameters

::xmog_java_array_template< ::java::lang::reflect::Method > java::lang::Class::getDeclaredMethods ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Returns an array of Method objects reflecting all the methods declared by the class or interface represented by this Class object.
This includes public, protected, default (package) access, and private methods, but excludes inherited methods. The elements in the array returned are not sorted and are not in any particular order. This method returns an array of length 0 if the class or interface declares no methods, or if this Class object represents a primitive type, an array class, or void. The class initialization method <clinit> is not included in the returned array. If the class declares multiple public member methods with the same parameter types, they are all included in the returned array.
See The Java Language Specification, section 8.2.
If there is a security manager, this method first calls the security manager's checkMemberAccess method with this and Member.DECLARED as its arguments. If the class is in a package, then this method also calls the security manager's checkPackageAccess method with the package name as its argument. Either of these calls could result in a SecurityException.

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the array of Method objects representing all the declared methods of this class

::java::lang::Class java::lang::Class::getDeclaringClass ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

If the class or interface represented by this Class object is a member of another class, returns the Class object representing the class in which it was declared.
This method returns null if this class or interface is not a member of any other class. If this Class object represents an array class, a primitive type, or void,then this method returns null.

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the declaring class for this class

::java::lang::reflect::Field java::lang::Class::getField ( const ::java::lang::String & name,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Returns a Field object that reflects the specified public member field of the class or interface represented by this Class object.
The name parameter is a String specifying the simple name of the desired field.
If there is a security manager, this method first calls the security manager's checkMemberAccess method with this and Member.PUBLIC as its arguments. If the class is in a package, then this method also calls the security manager's checkPackageAccess method with the package name as its argument. Either of these calls could result in a SecurityException.
The field to be reflected is determined by the algorithm that follows. Let C be the class represented by this object:

If C declares a public field with the name specified, that is the field to be reflected.

If no field was found in step 1 above, this algorithm is applied recursively to each direct superinterface of C. The direct superinterfaces are searched in the order they were declared.

If no field was found in steps 1 and 2 above, and C has a superclass S, then this algorithm is invoked recursively upon S. If C has no superclass, then a NoSuchFieldException is thrown.

See The Java Language Specification, sections 8.2 and 8.3.

Parameters:

name the field name

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the Field object of this class specified by name

::xmog_java_array_template< ::java::lang::reflect::Field > java::lang::Class::getFields ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Returns an array containing Field objects reflecting all the accessible public fields of the class or interface represented by this Class object.
The elements in the array returned are not sorted and are not in any particular order. This method returns an array of length 0 if the class or interface has no accessible public fields, or if it represents an array class, a primitive type, or void.
Specifically, if this Class object represents a class, this method returns the public fields of this class and of all its superclasses. If this Class object represents an interface, this method returns the fields of this interface and of all its superinterfaces.
If there is a security manager, this method first calls the security manager's checkMemberAccess method with this and Member.PUBLIC as its arguments. If the class is in a package, then this method also calls the security manager's checkPackageAccess method with the package name as its argument. Either of these calls could result in a SecurityException.
The implicit length field for array class is not reflected by this method. User code should use the methods of class Array to manipulate arrays.
See The Java Language Specification, sections 8.2 and 8.3.

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the array of Field objects representing the public fields

::xmog_java_array_template< ::java::lang::Class > java::lang::Class::getInterfaces ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Determines the interfaces implemented by the class or interface represented by this object.
If this object represents a class, the return value is an array containing objects representing all interfaces implemented by the class. The order of the interface objects in the array corresponds to the order of the interface names in the implements clause of the declaration of the class represented by this object. For example, given the declaration: <blockquote>

class Shimmer implements FloorWax, DessertTopping { ... }

</blockquote> suppose the value of s is an instance of Shimmer; the value of the expression: <blockquote>

s.getClass().getInterfaces()[0]

</blockquote> is the Class object that represents interface FloorWax; and the value of: <blockquote>

s.getClass().getInterfaces()[1]

</blockquote> is the Class object that represents interface DessertTopping.
If this object represents an interface, the array contains objects representing all interfaces extended by the interface. The order of the interface objects in the array corresponds to the order of the interface names in the extends clause of the declaration of the interface represented by this object.
If this object represents a class or interface that implements no interfaces, the method returns an array of length 0.
If this object represents a primitive type or void, the method returns an array of length 0.

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
an array of interfaces implemented by this class.

::java::lang::reflect::Method java::lang::Class::getMethod ( const ::java::lang::String & name,

const ::xmog_java_array_template< ::java::lang::Class > & parameterTypes,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Returns a Method object that reflects the specified public member method of the class or interface represented by this Class object.
The name parameter is a String specifying the simple name the desired method. The parameterTypes parameter is an array of Class objects that identify the method's formal parameter types, in declared order. If parameterTypes is null, it is treated as if it were an empty array.
If there is a security manager, this method first calls the security manager's checkMemberAccess method with this and Member.PUBLIC as its arguments. If the class is in a package, then this method also calls the security manager's checkPackageAccess method with the package name as its argument. Either of these calls could result in a SecurityException.
If the name is "<init>"or "<clinit>" a NoSuchMethodException is raised. Otherwise, the method to be reflected is determined by the algorithm that follows. Let C be the class represented by this object:

C is searched for any matching methods. If no matching method is found, the algorithm of step 1 is invoked recursively on the superclass of C.

If no method was found in step 1 above, the superinterfaces of C are searched for a matching method. If any such method is found, it is reflected.

To find a matching method in a class C: If C declares exactly one public method with the specified name and exactly the same formal parameter types, that is the method reflected. If more than one such method is found in C, and one of these methods has a return type that is more specific than any of the others, that method is reflected; otherwise one of the methods is chosen arbitrarily.
See The Java Language Specification, sections 8.2 and 8.4.

Parameters:

name the name of the method

parameterTypes the list of parameters

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the Method object that matches the specified name and parameterTypes

::xmog_java_array_template< ::java::lang::reflect::Method > java::lang::Class::getMethods ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Returns an array containing Method objects reflecting all the public member methods of the class or interface represented by this Class object, including those declared by the class or interface and and those inherited from superclasses and superinterfaces.
The elements in the array returned are not sorted and are not in any particular order. This method returns an array of length 0 if this Class object represents a class or interface that has no public member methods, or if this Class object represents an array class, primitive type, or void.
If there is a security manager, this method first calls the security manager's checkMemberAccess method with this and Member.PUBLIC as its arguments. If the class is in a package, then this method also calls the security manager's checkPackageAccess method with the package name as its argument. Either of these calls could result in a SecurityException.
The class initialization method <clinit> is not included in the returned array. If the class declares multiple public member methods with the same parameter types, they are all included in the returned array.
See The Java Language Specification, sections 8.2 and 8.4.

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the array of Method objects representing the public methods of this class

jint java::lang::Class::getModifiers ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Returns the Java language modifiers for this class or interface, encoded in an integer.
The modifiers consist of the Java Virtual Machine's constants for public, protected, private, final, static, abstract and interface; they should be decoded using the methods of class Modifier.
If the underlying class is an array class, then its public, private and protected modifiers are the same as those of its component type. If this Class represents a primitive type or void, its public modifier is always true, and its protected and private modifiers are always false. If this object represents an array class, a primitive type or void, then its final modifier is always true and its interface modifier is always false. The values of its other modifiers are not determined by this specification.
The modifier encodings are defined in The Java Virtual Machine Specification, table 4.1.

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the int representing the modifiers for this class

::java::lang::String java::lang::Class::getName ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Returns the name of the entity (class, interface, array class, primitive type, or void) represented by this Class object, as a String.
If this class object represents a reference type that is not an array type then the binary name of the class is returned, as specified by the Java Language Specification, Second Edition.
If this class object represents a primitive type or void, then the name returned is a String equal to the Java language keyword corresponding to the primitive type or void.
If this class object represents a class of arrays, then the internal form of the name consists of the name of the element type preceded by one or more '[' characters representing the depth of the array nesting. The encoding of element type names is as follows:
<blockquote>

Element Type Encoding

boolean Z

byte B

char C

class or interface Lclassname;

double D

float F

int I

long J

short S

</blockquote>
The class or interface name classname is the binary name of the class specified above.
Examples: <blockquote>

String.class.getName() returns "java.lang.String" byte.class.getName() returns "byte" (new Object[3]).getClass().getName() returns "[Ljava.lang.Object;" (new int[3][4][5][6][7][8][9]).getClass().getName() returns "[[[[[[[I"

</blockquote>

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the name of the class or interface represented by this object.

::java::io::InputStream java::lang::Class::getResourceAsStream ( const ::java::lang::String & name,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Finds a resource with a given name.
This method returns null if no resource with this name is found. The rules for searching resources associated with a given class are implemented by the defining class loader of the class.
This method delegates the call to its class loader, after making these changes to the resource name: if the resource name starts with "/", it is unchanged; otherwise, the package name is prepended to the resource name after converting "." to "/". If this object was loaded by the bootstrap loader, the call is delegated to ClassLoader.getSystemResourceAsStream.

Parameters:

name name of the desired resource

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
a java.io.InputStream object.

::xmog_java_array_template< ::java::lang::Object > java::lang::Class::getSigners ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Gets the signers of this class.

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the signers of this class, or null if there are no signers. In particular, this method returns null if this object represents a primitive type or void.

::java::lang::Class java::lang::Class::getSuperclass ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Returns the Class representing the superclass of the entity (class, interface, primitive type or void) represented by this Class.
If this Class represents either the Object class, an interface, a primitive type, or void, then null is returned. If this object represents an array class then the Class object representing the Object class is returned.

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the superclass of the class represented by this object.

bool java::lang::Class::isArray ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Determines if this Class object represents an array class.

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
true if this object represents an array class; false otherwise.

bool java::lang::Class::isAssignableFrom ( const ::java::lang::Class & cls,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Determines if the class or interface represented by this Class object is either the same as, or is a superclass or superinterface of, the class or interface represented by the specified Class parameter.
It returns true if so; otherwise it returns false. If this Class object represents a primitive type, this method returns true if the specified Class parameter is exactly this Class object; otherwise it returns false.
Specifically, this method tests whether the type represented by the specified Class parameter can be converted to the type represented by this Class object via an identity conversion or via a widening reference conversion. See The Java Language Specification, sections 5.1.1 and 5.1.4 , for details.

Parameters:

cls the Class object to be checked

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
the boolean value indicating whether objects of the type cls can be assigned to objects of this class

bool java::lang::Class::isInstance ( const ::java::lang::Object & obj,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Determines if the specified Object is assignment-compatible with the object represented by this Class.
This method is the dynamic equivalent of the Java language instanceof operator. The method returns true if the specified Object argument is non-null and can be cast to the reference type represented by this Class object without raising a ClassCastException. It returns false otherwise.
Specifically, if this Class object represents a declared class, this method returns true if the specified Object argument is an instance of the represented class (or of any of its subclasses); it returns false otherwise. If this Class object represents an array class, this method returns true if the specified Object argument can be converted to an object of the array class by an identity conversion or by a widening reference conversion; it returns false otherwise. If this Class object represents an interface, this method returns true if the class or any superclass of the specified Object argument implements this interface; it returns false otherwise. If this Class object represents a primitive type, this method returns false.

Parameters:

obj the object to check

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
true if obj is an instance of this class

bool java::lang::Class::isInterface ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Determines if the specified Class object represents an interface type.

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
true if this object represents an interface; false otherwise.

bool java::lang::Class::isPrimitive ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Determines if the specified Class object represents a primitive type.
There are nine predefined Class objects to represent the eight primitive types and void. These are created by the Java Virtual Machine, and have the same names as the primitive types that they represent, namely boolean, byte, char, short, int, long, float, and double.
These objects may only be accessed via the following public static final variables, and are the only Class objects for which this method returns true.

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
true if and only if this class represents a primitive type

::java::lang::Object java::lang::Class::newInstance ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Creates a new instance of the class represented by this Class object.
The class is instantiated as if by a new expression with an empty argument list. The class is initialized if it has not already been initialized.
If there is a security manager, this method first calls the security manager's checkMemberAccess method with this and Member.PUBLIC as its arguments. If the class is in a package, then this method also calls the security manager's checkPackageAccess method with the package name as its argument. Either of these calls could result in a SecurityException.

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
a newly allocated instance of the class represented by this object.

::java::lang::String java::lang::Class::toString ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Converts the object to a string.
The string representation is the string "class" or "interface", followed by a space, and then by the fully qualified name of the class in the format returned by getName. If this Class object represents a primitive type, this method returns the name of the primitive type. If this Class object represents void this method returns "void".

Parameters:

p_xenv the local call environment. The default value is NULL.

f_xflags the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

Returns:
a string representation of this class object.

Reimplemented from java::lang::Object.

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

java_lang_Class.h

Generated on Fri Jun 16 10:19:22 2006 for JMS Courier for C++ by

1.4.1

java::lang::Class Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation