ridljar/com/sun/star/uno/IMemberDescription.java

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: IMemberDescription.java,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 package com.sun.star.uno;
  32
  33 /**
  34  * The <code>IMemberDescription</code> is the base interface
  35  * for for the special subset of typedescriptions, which describe
  36  * members of IDL structs or interfeces.
  37  *
  38  * @deprecated This interface does not cover all the features supported by the
  39  * corresponding (unpublished) implementation.  But no client code should need
  40  * to access this functionality, anyway.
  41  */
  42 public interface IMemberDescription {
  43     /**
  44      * Gives the name of this member.
  45      * <p>
  46      * @return  the name
  47      */
  48     String getName();
  49
  50     /**
  51      * Indicates if this member is unsigned. (Not useful for IMethodDescription).
  52      * <p>
  53      * @return  the unsigned state
  54      */
  55     boolean isUnsigned();
  56
  57     /**
  58      * Indicates if this member is an any.
  59      * <p>
  60      * @return  the any state
  61      */
  62     boolean isAny();
  63
  64     /**
  65      * Indicates if this member is an interface.
  66      * <p>
  67      * @return  the interface state
  68      */
  69     boolean isInterface();
  70
  71     /**
  72      * Gives the relative index of this member in the declaring
  73      * interface or struct (including superclasses).
  74      * <p>
  75      * @return  the relative index of this member
  76      */
  77     int getIndex();
  78 }