KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jdt > core > jdom > IDOMMember


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.jdt.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  * @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  */
28 public interface IDOMMember extends IDOMNode {
29 /**
30  * Returns the comment associated with this member (including comment delimiters).
31  *
32  * @return the comment, or <code>null</code> if this member has no associated
33  * comment
34  */
35 public String JavaDoc getComment();
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  * Sets the comment associated with this member. The comment will appear
46  * before the member in the source. The comment must be properly formatted, including
47  * delimiters. A <code>null</code> comment indicates no comment. This member's
48  * deprecated flag is automatically set to reflect the deprecated tag in the
49  * comment.
50  *
51  * @param comment the comment, including comment delimiters, or
52  * <code>null</code> indicating this member should have no associated comment
53  * @see #setFlags(int)
54  */
55 public void setComment(String JavaDoc comment);
56 /**
57  * Sets the flags for this member. The flags can be examined using the
58  * <code>Flags</code> class. The deprecated flag passed in is ignored.
59  *
60  * @param flags the flags
61  * @see org.eclipse.jdt.core.Flags
62  */
63 public void setFlags(int flags);
64 }
65
Popular Tags