1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
package com.sun.star.uno;
/**
* The <code>ITypeDescription</code> allows to examine a type
* in detail (e.g. it is used for marshaling/unmarshaling).
*
* @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.
*/
public interface ITypeDescription {
/**
* Gets the <code>ITypeDescription</code> of the
* super, if it exists.
* <p>
* @return the <code>ITypeDescription</code>.
*/
ITypeDescription getSuperType();
/**
* Gets the <code>IMethodDescription</code> for every
* method, if this type is an interface. Otherwise
* returns <code>null</code>.
* <p>
* @return the <code>IMethodDescription[]</code>.
*/
IMethodDescription []getMethodDescriptions();
/**
* Gets the <code>IMethodDescription</code> for the
* method with index methodId, if it exists, otherwise
* returns <code>null</code>.
* <p>
* @return the <code>IMethodDescription</code>.
*/
IMethodDescription getMethodDescription(int methodId);
/**
* Gets the <code>IMethodDescription</code> for the
* method with the name <code>name</code>, if it exists,
* otherwise returns <code>null</code>.
* <p>
* @return the <code>IMethodDescription</code>.
*/
IMethodDescription getMethodDescription(String name);
/**
* Gets the <code>IFieldDescription</code> for every
* field, if this type is an interface. Otherwise
* returns <code>null</code>.
* <p>
* @return the <code>IFieldDescription[]</code>.
*/
IFieldDescription []getFieldDescriptions();
/**
* Gets the <code>IFieldDescription</code> for the
* field with the name <code>name</code>, if it exists,
* otherwise returns <code>null</code>.
* <p>
* @return the <code>IFieldDescription</code>.
*/
IFieldDescription getFieldDescription(String name);
/**
* Gets the IDL <code>TypeClass</code> of the type.
* <p>
* @return the <code>TypeClass</code>.
*/
TypeClass getTypeClass();
/**
* Gets the component <code>ITypeDescription</code> if
* this is an array type, otherwise returns <code>null</code>.
* <p>
* @return the <code>ITypeDescription</code>
*/
ITypeDescription getComponentType();
/**
* Gets the (UNO) type name.
*
* <p>The following table lists how UNO types map to type names:</p>
* <table>
* <thead>
* <tr><th>UNO type</th><th>type name</th></tr>
* </thead>
* <tbody>
* <tr><td>VOID</td><td><code>"void"</code></td></tr>
* <tr><td>BOOLEAN</td><td><code>"boolean"</code></td></tr>
* <tr><td>CHAR</td><td><code>"char"</code></td></tr>
* <tr><td>BYTE</td><td><code>"byte"</code></td></tr>
* <tr><td>SHORT</td><td><code>"short"</code></td></tr>
* <tr>
* <td>UNSIGNED SHORT</td><td><code>"unsigned short"</code></td>
* </tr>
* <tr><td>LONG</td><td><code>"long"</code></td></tr>
* <tr><td>UNSIGNED LONG</td><td><code>"unsigned long"</code></td></tr>
* <tr><td>HYPER</td><td></td><code>"hyper"</code></tr>
* <tr>
* <td>UNSIGNED HYPER</td><td></td><code>"unsigned hyper"</code>
* </tr>
* <tr><td>FLOAT</td><td></td><code>"float"</code></tr>
* <tr><td>DOUBLE</td><td></td><code>"double"</code></tr>
* <tr><td>STRING</td><td></td><code>"string"</code></tr>
* <tr><td>TYPE</td><td></td><code>"type"</code></tr>
* <tr><td>ANY</td><td></td><code>"any"</code></tr>
* <tr>
* <td>sequence type of base type <var>T</var></td>
* <td><code>"[]"</code> followed by type name for <var>T</var></td>
* </tr>
* <tr>
* <td>enum type named <var>N</var></td>
* <td><var>N</var> (see below)</td>
* </tr>
* <tr>
* <td>struct type named <var>N</var></td>
* <td><var>N</var> (see below)</td>
* </tr>
* <tr>
* <td>exception type named <var>N</var>
* </td><td><var>N</var> (see below)</td>
* </tr>
* <tr>
* <td>interface type named <var>N</var></td>
* <td><var>N</var> (see below)</td>
* </tr>
* <tbody>
* </table>
* <p>For a UNO type named <var>N</var>, consisting of a sequence of module
* names <var>M<sub>1</sub></var>, ..., <var>M<sub>n</sub></var> followed by
* a simple name <var>S</var>, the corresponding type name consists of the
* same sequence of module names and simple name, with <code>"."</code>
* seperating the individual elements.</p>
*
* @return the type name.
*/
String getTypeName();
/**
* Gets the (Java) array type name.
*
* <p>The array type name is defined to be the Java class name (as returned
* by <code>Class.forName</code>) of the Java array class that corresponds
* to the UNO sequence type with this type (the UNO type represented by this
* <code>ITypeDescription</code> instance) as base type. For an
* <code>ITypeDescription</code> instance representing the UNO type VOID,
* the array type name is defined to be
* <code>"[Ljava.lang.Void;"</code>.</p>
*
* @return the array type name.
*/
String getArrayTypeName();
/**
* Gets the corresponding java class for the type.
* <p>
* @return the corresponding java class.
*/
Class<?> getZClass();
}
|
