01: /*******************************************************************************
02: * Copyright (c) 2000, 2006 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.jdt.core.jdom;
11:
12: /**
13: * An <code>IDOMMember</code> defines functionality common to nodes, which
14: * can be members of types.
15: * <p>
16: * This interface is not intended to be implemented by clients.
17: * </p>
18: *
19: * @see IDOMType
20: * @see IDOMMethod
21: * @see IDOMField
22: * @see IDOMInitializer
23: * @deprecated The JDOM was made obsolete by the addition in 2.0 of the more
24: * powerful, fine-grained DOM/AST API found in the
25: * org.eclipse.jdt.core.dom package.
26: */
27: public interface IDOMMember extends IDOMNode {
28: /**
29: * Returns the comment associated with this member (including comment delimiters).
30: *
31: * @return the comment, or <code>null</code> if this member has no associated
32: * comment
33: */
34: public String getComment();
35:
36: /**
37: * Returns the flags for this member. The flags can be examined using the
38: * <code>Flags</code> class.
39: *
40: * @return the flags
41: * @see org.eclipse.jdt.core.Flags
42: */
43: public int getFlags();
44:
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: */
56: public void setComment(String comment);
57:
58: /**
59: * Sets the flags for this member. The flags can be examined using the
60: * <code>Flags</code> class. The deprecated flag passed in is ignored.
61: *
62: * @param flags the flags
63: * @see org.eclipse.jdt.core.Flags
64: */
65: public void setFlags(int flags);
66: }
|