com.sun.star.lib.uno.typedesc

Class TypeDescription

java.lang.Object

com.sun.star.lib.uno.typedesc.TypeDescription

All Implemented Interfaces:

ITypeDescription

public final class TypeDescription
extends Object
implements ITypeDescription

Supplies information about UNO types.

Since:

UDK2.0

Method Summary

Modifier and Type	Method and Description
String	getArrayTypeName() Gets the (Java) array type name.
ITypeDescription	getComponentType() Gets the component ITypeDescription if this is an array type, otherwise returns null.
IFieldDescription	getFieldDescription(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.
IMethodDescription	getMethodDescription(int methodId) Gets the IMethodDescription for the method with index methodId, if it exists, otherwise returns null.
IMethodDescription	getMethodDescription(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.
ITypeDescription	getSuperType() Gets the ITypeDescription of the super, if it exists.
com.sun.star.uno.TypeClass	getTypeClass() Gets the IDL TypeClass of the type.
static TypeDescription	getTypeDescription(Class<?> zClass)
static TypeDescription	getTypeDescription(String typeName)
static TypeDescription	getTypeDescription(Type type)
static TypeDescription	getTypeDescription(com.sun.star.uno.TypeClass typeClass)
String	getTypeName() Gets the (UNO) type name.
Class<?>	getZClass() Gets the corresponding java class for the type.
boolean	hasTypeArguments()
static boolean	isTypeClassSimple(com.sun.star.uno.TypeClass typeClass)
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getTypeDescription

public static TypeDescription getTypeDescription(String typeName)
                                          throws ClassNotFoundException

Throws:

ClassNotFoundException

getTypeDescription

public static TypeDescription getTypeDescription(Class<?> zClass)

getTypeDescription

public static TypeDescription getTypeDescription(Type type)
                                          throws ClassNotFoundException

Throws:

ClassNotFoundException

getTypeDescription

public static TypeDescription getTypeDescription(com.sun.star.uno.TypeClass typeClass)

isTypeClassSimple

public static boolean isTypeClassSimple(com.sun.star.uno.TypeClass typeClass)

getSuperType

public ITypeDescription getSuperType()

Description copied from interface: ITypeDescription

Gets the ITypeDescription of the super, if it exists.

Specified by:

getSuperType in interface ITypeDescription

Returns:

the ITypeDescription.

getMethodDescriptions

public IMethodDescription[] getMethodDescriptions()

Description copied from interface: ITypeDescription

Gets the IMethodDescription for every method, if this type is an interface. Otherwise returns null.

Specified by:

getMethodDescriptions in interface ITypeDescription

Returns:

the IMethodDescription[].

getMethodDescription

public IMethodDescription getMethodDescription(int methodId)

Description copied from interface: ITypeDescription

Gets the IMethodDescription for the method with index methodId, if it exists, otherwise returns null.

Specified by:

getMethodDescription in interface ITypeDescription

Parameters:

methodId - the index.

Returns:

the IMethodDescription.

getMethodDescription

public IMethodDescription getMethodDescription(String name)

Description copied from interface: ITypeDescription

Gets the IMethodDescription for the method with the name name, if it exists, otherwise returns null.

Specified by:

getMethodDescription in interface ITypeDescription

Parameters:

name - the name of the method.

Returns:

the IMethodDescription.

getFieldDescriptions

public IFieldDescription[] getFieldDescriptions()

Description copied from interface: ITypeDescription

Gets the IFieldDescription for every field, if this type is an interface. Otherwise returns null.

Specified by:

getFieldDescriptions in interface ITypeDescription

Returns:

the IFieldDescription[].

getFieldDescription

public IFieldDescription getFieldDescription(String name)

Description copied from interface: ITypeDescription

Gets the IFieldDescription for the field with the name name, if it exists, otherwise returns null.

Specified by:

getFieldDescription in interface ITypeDescription

Parameters:

name - the name of the field.

Returns:

the IFieldDescription.

getTypeClass

public com.sun.star.uno.TypeClass getTypeClass()

Description copied from interface: ITypeDescription

Gets the IDL TypeClass of the type.

Specified by:

getTypeClass in interface ITypeDescription

Returns:

the TypeClass.

getComponentType

public ITypeDescription getComponentType()

Description copied from interface: ITypeDescription

Gets the component ITypeDescription if this is an array type, otherwise returns null.

Specified by:

getComponentType in interface ITypeDescription

Returns:

the ITypeDescription

getTypeName

public String getTypeName()

Description copied from interface: ITypeDescription

Gets the (UNO) type name.

Mapping from UNO types to type names

UNO type	type name
VOID	"void"
BOOLEAN	"boolean"
CHAR	"char"
BYTE	"byte"
SHORT	"short"
UNSIGNED SHORT	"unsigned short"
LONG	"long"
UNSIGNED LONG	"unsigned long"
HYPER	"hyper"
UNSIGNED HYPER	"unsigned hyper"
FLOAT	"float"
DOUBLE	"double"
STRING	"string"
TYPE	"type"
ANY	"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 M₁, ..., M_n followed by a simple name S, the corresponding type name consists of the same sequence of module names and simple name, with "." separating the individual elements.

Specified by:

getTypeName in interface ITypeDescription

Returns:

the type name.

getArrayTypeName

public String getArrayTypeName()

Description copied from interface: ITypeDescription

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;".

Specified by:

getArrayTypeName in interface ITypeDescription

Returns:

the array type name.

getZClass

public Class<?> getZClass()

Description copied from interface: ITypeDescription

Gets the corresponding java class for the type.

Specified by:

getZClass in interface ITypeDescription

Returns:

the corresponding java class.

hasTypeArguments

public boolean hasTypeArguments()

toString

public String toString()

Overrides:

toString in class Object