com.dotNet4Java

Class TClrAssembly

java.lang.Object

com.dotNet4Java.TClrBase

com.dotNet4Java.TClrAssembly

All Implemented Interfaces:

IClrAssembly, IClrBase, java.lang.AutoCloseable

public class TClrAssembly
extends TClrBase
implements IClrAssembly

Represents an assembly, which is a reusable, versionable, and self-describing building block of a common language runtime application.

Constructor Summary

Constructors

Constructor and Description
TClrAssembly(DotNetNativeTypes.ClrAssembly assembly) Create an instance of the .Net Assembly using the specified clr assembly pointer

Method Summary

Modifier and Type	Method and Description
void	close()
static IClrType	findType(java.lang.String typeName) Gets the Type object with the specified name in all the assemblies loaded by the CLR application domains.
protected DotNetNativeTypes.ClrObject	getClrObject() Gets the base clr object pointer.
DotNetNativeTypes.ClrAssembly	getDefaultPointer() Gets the default clr assembly pointer.
java.lang.String	getFullName() Gets the display name of the assembly.
boolean	getGlobalAssemblyCache() Gets a value indicating whether the assembly was loaded from the global assembly cache.
java.lang.String	getImageRuntimeVersion() Gets a string representing the version of the common language runtime (CLR) saved in the file containing the manifest.
java.lang.String	getLocation() Gets the full path or UNC location of the loaded file that contains the manifest.
static IClrAssembly	getRegisteredAssembly(java.lang.String assemblyID) Gets the registered .Net Assembly
IClrType	getType() Gets the exact runtime type of the current instance.
IClrType	getType(java.lang.String typeName) Gets the Type object with the specified name in the assembly instance.
IClrType	getType(java.lang.String typeName, boolean throwError) Gets the Type object with the specified name in the assembly instance and optionally throws an exception if the type is not found.
IClrType	getType(java.lang.String typeName, boolean throwError, boolean ignoreCase) Gets the Type object with the specified name in the assembly instance, with the options of ignoring the case, and of throwing an exception if the type is not found.
IClrType[]	getTypes() Gets the types defined in this assembly.
static IClrAssembly	load(java.lang.String assemblyString) Loads an assembly with the specified name.
static IClrAssembly	loadFile(java.lang.String path) Loads the contents of an assembly file on the specified path.
static IClrAssembly	loadFrom(java.lang.String assemblyFile) Loads an assembly given its file name or path.
static void	loadRegisteredAssembly(java.lang.String assemblyID) Load the registered .Net Assembly using the specified AssemblyId
static IClrAssembly	loadWithPartialName(java.lang.String partialName) Loads an assembly from the application directory or from the global assembly cache using a partial name.
static void	register(java.lang.String assemblyID, java.lang.String location, AssemblyLoadType loadType) Register a .Net Assembly
static void	register(java.lang.String assemblyID, java.lang.String location, AssemblyLoadType loadType, boolean useUnsafeLoadFrom) Register a .Net Assembly
static void	register(java.lang.String assemblyID, java.lang.String wsdlPath, java.lang.String domain, java.lang.String userName, java.lang.String password, WsdlProtocol protocol) Register a .Net Assembly
static IClrAssembly	unsafeLoadFrom(java.lang.String assemblyFile) Loads an assembly into the load-from context, bypassing some security checks.

Methods inherited from class com.dotNet4Java.TClrBase

clearRef, equals, getBaseObject, getFieldValue, getPropertyIndexValue, getPropertyIndexValue, getPropertyValue, invokeGenericClrObjectMethod, invokeGenericMethod, invokeMethod, invokeVoidMethod, registerEvent, registerEventCallBack, registerEventCallBackWithReturn, setFieldValue, setPropertyIndexValue, setPropertyIndexValue, setPropertyValue, unRegisterEvent, unRegisterEventCallBack, unRegisterEventCallBackWithReturn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.dotNet4Java.IClrBase

equals, getBaseObject, getFieldValue, getPropertyIndexValue, getPropertyIndexValue, getPropertyValue, invokeGenericMethod, invokeMethod, invokeVoidMethod, registerEventCallBack, registerEventCallBackWithReturn, setFieldValue, setPropertyIndexValue, setPropertyIndexValue, setPropertyValue, unRegisterEventCallBack, unRegisterEventCallBackWithReturn

Constructor Detail

TClrAssembly

public TClrAssembly(DotNetNativeTypes.ClrAssembly assembly)

Create an instance of the .Net Assembly using the specified clr assembly pointer

Parameters:

assembly - The clr Assembly pointer

Method Detail

getRegisteredAssembly

public static IClrAssembly getRegisteredAssembly(java.lang.String assemblyID)
                                          throws EClrError

Gets the registered .Net Assembly

Parameters:

assemblyID - The ID of the registered .Net Assembly

Returns:

The registered .Net Assembly

Throws:

EClrError

loadRegisteredAssembly

public static void loadRegisteredAssembly(java.lang.String assemblyID)
                                   throws EClrError

Load the registered .Net Assembly using the specified AssemblyId

Parameters:

assemblyID - The Id of the registered .Net Assembly.

Throws:

EClrError

register

public static final void register(java.lang.String assemblyID,
                                  java.lang.String location,
                                  AssemblyLoadType loadType,
                                  boolean useUnsafeLoadFrom)

Register a .Net Assembly

Parameters:

assemblyID - The id of the .Net Assembly to register.

location - The location of the Assembly to load.

loadType - Controls how the assembly is loaded from the location.

useUnsafeLoadFrom - Determines if the assembly to load will be bypassing some security checks.

register

public static final void register(java.lang.String assemblyID,
                                  java.lang.String location,
                                  AssemblyLoadType loadType)

Register a .Net Assembly

Parameters:

assemblyID - The id of the .Net Assembly to register.

location - The location of the Assembly to load.

loadType - Controls how the assembly is loaded from the location.

register

public static final void register(java.lang.String assemblyID,
                                  java.lang.String wsdlPath,
                                  java.lang.String domain,
                                  java.lang.String userName,
                                  java.lang.String password,
                                  WsdlProtocol protocol)

Register a .Net Assembly

Parameters:

assemblyID - The id of the .Net Assembly to register.

wsdlPath -

domain -

userName -

password -

protocol -

loadFrom

public static final IClrAssembly loadFrom(java.lang.String assemblyFile)
                                   throws EClrError

Loads an assembly given its file name or path.

Parameters:

assemblyFile - The name or path of the file that contains the manifest of the assembly.

Returns:

The loaded assembly.

Throws:

EClrError

load

public static final IClrAssembly load(java.lang.String assemblyString)
                               throws EClrError

Loads an assembly with the specified name.

Parameters:

assemblyString - The long or short form of the assembly name.

Returns:

The loaded assembly.

Throws:

EClrError

loadFile

public static final IClrAssembly loadFile(java.lang.String path)
                                   throws EClrError

Loads the contents of an assembly file on the specified path.

Parameters:

path - The fully qualified path of the file to load.

Returns:

The loaded assembly.

Throws:

EClrError

loadWithPartialName

public static final IClrAssembly loadWithPartialName(java.lang.String partialName)
                                              throws EClrError

Loads an assembly from the application directory or from the global assembly cache using a partial name.

Parameters:

partialName - The short form of the assembly name.

Returns:

The loaded assembly.

Throws:

EClrError

unsafeLoadFrom

public static final IClrAssembly unsafeLoadFrom(java.lang.String assemblyFile)
                                         throws EClrError

Loads an assembly into the load-from context, bypassing some security checks.

Parameters:

assemblyFile - The name or path of the file that contains the manifest of the assembly.

Returns:

The loaded assembly.

Throws:

EClrError

findType

public static final IClrType findType(java.lang.String typeName)
                               throws EClrError

Gets the Type object with the specified name in all the assemblies loaded by the CLR application domains.

Parameters:

typeName - The full name of the type.

Returns:

An object that represents the specified class, or null if the type is not found.

Throws:

EClrError

getClrObject

protected DotNetNativeTypes.ClrObject getClrObject()
                                            throws EClrError

Gets the base clr object pointer.

Specified by:

getClrObject in class TClrBase

Returns:

The base clr object pointer.

Throws:

EClrError

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class TClrBase

Throws:

java.lang.Exception

getDefaultPointer

public DotNetNativeTypes.ClrAssembly getDefaultPointer()

Gets the default clr assembly pointer.

Specified by:

getDefaultPointer in interface IClrAssembly

Returns:

the default clr assembly pointer.

getFullName

public java.lang.String getFullName()
                             throws EClrError

Gets the display name of the assembly.

Specified by:

getFullName in interface IClrAssembly

Returns:

The display name of the assembly.

Throws:

EClrError

getLocation

public java.lang.String getLocation()
                             throws EClrError

Gets the full path or UNC location of the loaded file that contains the manifest.

Specified by:

getLocation in interface IClrAssembly

Returns:

The location of the loaded file that contains the manifest. If the loaded file was shadow-copied, the location is that of the file after being shadow-copied. If the assembly is loaded from a byte array, such as when using the Load(BigByte[]) method overload, the value returned is an empty string ("").

Throws:

EClrError

getGlobalAssemblyCache

public boolean getGlobalAssemblyCache()
                               throws EClrError

Gets a value indicating whether the assembly was loaded from the global assembly cache.

Specified by:

getGlobalAssemblyCache in interface IClrAssembly

Returns:

true if the assembly was loaded from the global assembly cache; otherwise, false.

Throws:

EClrError

getImageRuntimeVersion

public java.lang.String getImageRuntimeVersion()
                                        throws EClrError

Gets a string representing the version of the common language runtime (CLR) saved in the file containing the manifest.

Specified by:

getImageRuntimeVersion in interface IClrAssembly

Returns:

The CLR version folder name. This is not a full path.

Throws:

EClrError

getType

public IClrType getType(java.lang.String typeName,
                        boolean throwError,
                        boolean ignoreCase)
                 throws EClrError

Gets the Type object with the specified name in the assembly instance, with the options of ignoring the case, and of throwing an exception if the type is not found.

Specified by:

getType in interface IClrAssembly

Parameters:

typeName - The full name of the type.

throwError - true to throw an exception if the type is not found; false to return null.

ignoreCase - true to ignore the case of the type name; otherwise, false.

Returns:

An object that represents the specified .Net class.

Throws:

EClrError

getType

public IClrType getType(java.lang.String typeName,
                        boolean throwError)
                 throws EClrError

Gets the Type object with the specified name in the assembly instance and optionally throws an exception if the type is not found.

Specified by:

getType in interface IClrAssembly

Parameters:

typeName - The full name of the type.

throwError - true to throw an exception if the type is not found; false to return null.

Returns:

An object that represents the specified .Net class.

Throws:

EClrError

getType

public IClrType getType(java.lang.String typeName)
                 throws EClrError

Gets the Type object with the specified name in the assembly instance.

Specified by:

getType in interface IClrAssembly

Parameters:

typeName - The full name of the type.

Returns:

An object that represents the specified class, or null if the .Net class is not found.

Throws:

EClrError

getTypes

public IClrType[] getTypes()
                    throws java.lang.Exception

Gets the types defined in this assembly.

Specified by:

getTypes in interface IClrAssembly

Returns:

An array that contains all the types that are defined in this assembly.

Throws:

java.lang.Exception

getType

public IClrType getType()
                 throws EClrError

Gets the exact runtime type of the current instance.

Specified by:

getType in interface IClrBase

Overrides:

getType in class TClrBase

Returns:

the exact runtime type of the current instance.

Throws:

EClrError