net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/jdom/IDOMMember.java

   1 /*******************************************************************************
   2  * Copyright (c) 2000, 2003 IBM Corporation and others.
   3  * All rights reserved. This program and the accompanying materials
   4  * are made available under the terms of the Common Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/cpl-v10.html
   7  *
   8  * Contributors:
   9  *     IBM Corporation - initial API and implementation
  10  *******************************************************************************/
  11 package net.sourceforge.phpdt.core.jdom;
  12
  13 /**
  14  * An <code>IDOMMember</code> defines functionality common to nodes, which can
  15  * be members of types.
  16  * <p>
  17  * This interface is not intended to be implemented by clients.
  18  * </p>
  19  *
  20  * @see IDOMType
  21  * @see IDOMMethod
  22  * @see IDOMField
  23  * @see IDOMInitializer
  24  */
  25 public interface IDOMMember extends IDOMNode {
  26         /**
  27          * Returns the comment associated with this member (including comment
  28          * delimiters).
  29          *
  30          * @return the comment, or <code>null</code> if this member has no
  31          *         associated comment
  32          */
  33         public String getComment();
  34
  35         /**
  36          * Returns the flags for this member. The flags can be examined using the
  37          * <code>Flags</code> class.
  38          *
  39          * @return the flags
  40          * @see net.sourceforge.phpdt.core.Flags
  41          */
  42         public int getFlags();
  43
  44         /**
  45          * Sets the comment associated with this member. The comment will appear
  46          * before the member in the source. The comment must be properly formatted,
  47          * including delimiters. A <code>null</code> comment indicates no comment.
  48          * This member's deprecated flag is automatically set to reflect the
  49          * deprecated tag in the comment.
  50          *
  51          * @param comment
  52          *            the comment, including comment delimiters, or
  53          *            <code>null</code> indicating this member should have no
  54          *            associated comment
  55          * @see #setFlags
  56          */
  57         public void setComment(String comment);
  58
  59         /**
  60          * Sets the flags for this member. The flags can be examined using the
  61          * <code>Flags</code> class. The deprecated flag passed in is ignored.
  62          *
  63          * @param flags
  64          *            the flags
  65          * @see net.sourceforge.phpdt.core.Flags
  66          */
  67         public void setFlags(int flags);
  68 }