com.sun.star.uno

Interface ITypeDescription

public interface ITypeDescription

Deprecated: This interface does not cover all the features supported by the corresponding (unpublished) implementation. But no client code should need to access this functionality, anyway.

The ITypeDescription allows to examine a type in detail (e.g. it is used for marshaling/unmarshaling).
Method Summary
StringgetArrayTypeName()
Gets the (Java) array type name.
ITypeDescriptiongetComponentType()
Gets the component ITypeDescription if this is an array type, otherwise returns null.
IFieldDescriptiongetFieldDescription(String name)
Gets the IFieldDescription for the field with the name name, if it exists, otherwise returns null.
IFieldDescription[]getFieldDescriptions()
Gets the IFieldDescription for every field, if this type is an interface.
IMethodDescriptiongetMethodDescription(int methodId)
Gets the IMethodDescription for the method with index methodId, if it exists, otherwise returns null.
IMethodDescriptiongetMethodDescription(String name)
Gets the IMethodDescription for the method with the name name, if it exists, otherwise returns null.
IMethodDescription[]getMethodDescriptions()
Gets the IMethodDescription for every method, if this type is an interface.
ITypeDescriptiongetSuperType()
Gets the ITypeDescription of the super, if it exists.
TypeClassgetTypeClass()
Gets the IDL TypeClass of the type.
StringgetTypeName()
Gets the (UNO) type name.
ClassgetZClass()
Gets the corresponding java class for the type.

Method Detail

getArrayTypeName

public String getArrayTypeName()
Gets the (Java) array type name.

The array type name is defined to be the Java class name (as returned by Class.forName) of the Java array class that corresponds to the UNO sequence type with this type (the UNO type represented by this ITypeDescription instance) as base type. For an ITypeDescription instance representing the UNO type VOID, the array type name is defined to be "[Ljava.lang.Void;".

Returns: the array type name.

getComponentType

public ITypeDescription getComponentType()
Gets the component ITypeDescription if this is an array type, otherwise returns null.

Returns: the ITypeDescription

getFieldDescription

public IFieldDescription getFieldDescription(String name)
Gets the IFieldDescription for the field with the name name, if it exists, otherwise returns null.

Returns: the IFieldDescription.

getFieldDescriptions

public IFieldDescription[] getFieldDescriptions()
Gets the IFieldDescription for every field, if this type is an interface. Otherwise returns null.

Returns: the IFieldDescription[].

getMethodDescription

public IMethodDescription getMethodDescription(int methodId)
Gets the IMethodDescription for the method with index methodId, if it exists, otherwise returns null.

Returns: the IMethodDescription.

getMethodDescription

public IMethodDescription getMethodDescription(String name)
Gets the IMethodDescription for the method with the name name, if it exists, otherwise returns null.

Returns: the IMethodDescription.

getMethodDescriptions

public IMethodDescription[] getMethodDescriptions()
Gets the IMethodDescription for every method, if this type is an interface. Otherwise returns null.

Returns: the IMethodDescription[].

getSuperType

public ITypeDescription getSuperType()
Gets the ITypeDescription of the super, if it exists.

Returns: the ITypeDescription.

getTypeClass

public TypeClass getTypeClass()
Gets the IDL TypeClass of the type.

Returns: the TypeClass.

getTypeName

public String getTypeName()
Gets the (UNO) type name.

The following table lists how UNO types map to type names:

"hyper""unsigned hyper""float""double""string""type""any"
UNO typetype name
VOID"void"
BOOLEAN"boolean"
CHAR"char"
BYTE"byte"
SHORT"short"
UNSIGNED SHORT"unsigned short"
LONG"long"
UNSIGNED LONG"unsigned long"
HYPER
UNSIGNED HYPER
FLOAT
DOUBLE
STRING
TYPE
ANY
sequence type of base type T "[]" followed by type name for T
enum type named N N (see below)
struct type named N N (see below)
exception type named N N (see below)
interface type named N N (see below)

For a UNO type named N, consisting of a sequence of module names M1, ..., Mn followed by a simple name S, the corresponding type name consists of the same sequence of module names and simple name, with "." seperating the individual elements.

Returns: the type name.

getZClass

public Class getZClass()
Gets the corresponding java class for the type.

Returns: the corresponding java class.