xref: /AOO41X/main/ridljar/com/sun/star/uno/IMemberDescription.java (revision a046d00f64f7897a53f3356d02ce7dd043873852)
1*a046d00fSAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*a046d00fSAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*a046d00fSAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*a046d00fSAndrew Rist  * distributed with this work for additional information
6*a046d00fSAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*a046d00fSAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*a046d00fSAndrew Rist  * "License"); you may not use this file except in compliance
9*a046d00fSAndrew Rist  * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir  *
11*a046d00fSAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir  *
13*a046d00fSAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*a046d00fSAndrew Rist  * software distributed under the License is distributed on an
15*a046d00fSAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*a046d00fSAndrew Rist  * KIND, either express or implied.  See the License for the
17*a046d00fSAndrew Rist  * specific language governing permissions and limitations
18*a046d00fSAndrew Rist  * under the License.
19cdf0e10cSrcweir  *
20*a046d00fSAndrew Rist  *************************************************************/
21*a046d00fSAndrew Rist 
22*a046d00fSAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir package com.sun.star.uno;
25cdf0e10cSrcweir 
26cdf0e10cSrcweir /**
27cdf0e10cSrcweir  * The <code>IMemberDescription</code> is the base interface
28cdf0e10cSrcweir  * for for the special subset of typedescriptions, which describe
29cdf0e10cSrcweir  * members of IDL structs or interfeces.
30cdf0e10cSrcweir  *
31cdf0e10cSrcweir  * @deprecated This interface does not cover all the features supported by the
32cdf0e10cSrcweir  * corresponding (unpublished) implementation.  But no client code should need
33cdf0e10cSrcweir  * to access this functionality, anyway.
34cdf0e10cSrcweir  */
35cdf0e10cSrcweir public interface IMemberDescription {
36cdf0e10cSrcweir     /**
37cdf0e10cSrcweir      * Gives the name of this member.
38cdf0e10cSrcweir      * <p>
39cdf0e10cSrcweir      * @return  the name
40cdf0e10cSrcweir      */
getName()41cdf0e10cSrcweir     String getName();
42cdf0e10cSrcweir 
43cdf0e10cSrcweir     /**
44cdf0e10cSrcweir      * Indicates if this member is unsigned. (Not useful for IMethodDescription).
45cdf0e10cSrcweir      * <p>
46cdf0e10cSrcweir      * @return  the unsigned state
47cdf0e10cSrcweir      */
isUnsigned()48cdf0e10cSrcweir     boolean isUnsigned();
49cdf0e10cSrcweir 
50cdf0e10cSrcweir     /**
51cdf0e10cSrcweir      * Indicates if this member is an any.
52cdf0e10cSrcweir      * <p>
53cdf0e10cSrcweir      * @return  the any state
54cdf0e10cSrcweir      */
isAny()55cdf0e10cSrcweir     boolean isAny();
56cdf0e10cSrcweir 
57cdf0e10cSrcweir     /**
58cdf0e10cSrcweir      * Indicates if this member is an interface.
59cdf0e10cSrcweir      * <p>
60cdf0e10cSrcweir      * @return  the interface state
61cdf0e10cSrcweir      */
isInterface()62cdf0e10cSrcweir     boolean isInterface();
63cdf0e10cSrcweir 
64cdf0e10cSrcweir     /**
65cdf0e10cSrcweir      * Gives the relative index of this member in the declaring
66cdf0e10cSrcweir      * interface or struct (including superclasses).
67cdf0e10cSrcweir      * <p>
68cdf0e10cSrcweir      * @return  the relative index of this member
69cdf0e10cSrcweir      */
getIndex()70cdf0e10cSrcweir     int getIndex();
71cdf0e10cSrcweir }
72