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
  15  * can 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 delimiters).
  28  *
  29  * @return the comment, or <code>null</code> if this member has no associated
  30  *   comment
  31  */
  32 public String getComment();
  33 /**
  34  * Returns the flags for this member. The flags can be examined using the
  35  * <code>Flags</code> class.
  36  *
  37  * @return the flags
  38  * @see org.eclipse.jdt.core.Flags
  39  */
  40 public int getFlags();
  41 /**
  42  * Sets the comment associated with this member. The comment will appear
  43  * before the member in the source. The comment must be properly formatted, including
  44  * delimiters. A <code>null</code> comment indicates no comment. This member's
  45  * deprecated flag is automatically set to reflect the deprecated tag in the
  46  * comment.
  47  *
  48  * @param comment the comment, including comment delimiters, or
  49  *   <code>null</code> indicating this member should have no associated comment
  50  * @see #setFlags
  51  */
  52 public void setComment(String comment);
  53 /**
  54  * Sets the flags for this member. The flags can be examined using the
  55  * <code>Flags</code> class. The deprecated flag passed in is ignored.
  56  *
  57  * @param flags the flags
  58  * @see org.eclipse.jdt.core.Flags
  59  */
  60 public void setFlags(int flags);
  61 }