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