KickJava   Java API By Example, From Geeks To Geeks.

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


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  * Represents an import declaration.
15  * The corresponding syntactic unit is ImportDeclaration (JLS2 7.5).
16  * An import has no children and its parent is a compilation unit.
17  * <p>
18  * This interface is not intended to be implemented by clients.
19  * </p>
20  * @deprecated The JDOM was made obsolete by the addition in 2.0 of the more
21  * powerful, fine-grained DOM/AST API found in the
22  * org.eclipse.jdt.core.dom package.
23  */
24 public interface IDOMImport extends IDOMNode {
25 /**
26  * The <code>IDOMImport</code> refinement of this <code>IDOMNode</code>
27  * method returns the name of this import. The syntax for an import name
28  * corresponds to a fully qualified type name, or to an on-demand package name
29  * as defined by ImportDeclaration (JLS2 7.5).
30  *
31  * @return the name of this import
32  */
33 public String JavaDoc getName();
34 /**
35  * Returns whether this import declaration ends with <code>".*"</code>.
36  *
37  * @return <code>true</code> if this in an on-demand import
38  */
39 public boolean isOnDemand();
40
41 /**
42  * Returns the modifier flags for this import. The flags can be examined using class
43  * <code>Flags</code>. Only the static flag is meaningful for import declarations.
44  * @return the modifier flags for this import
45  * @see org.eclipse.jdt.core.Flags
46  * @since 3.0
47  */
48 int getFlags();
49
50 /**
51  * Sets the modifier flags for this import. The flags can be examined using class
52  * <code>Flags</code>. Only the static flag is meaningful for import declarations.
53  *
54  * @param flags the modifier flags for this import
55  * @see org.eclipse.jdt.core.Flags
56  * @since 3.0
57  */
58 void setFlags(int flags);
59
60 /**
61  * The <code>IDOMImport</code> refinement of this <code>IDOMNode</code>
62  * method sets the name of this import. The syntax for an import name
63  * corresponds to a fully qualified type name, or to an on-demand package name
64  * as defined by ImportDeclaration (JLS2 7.5).
65  *
66  * @param name the given name
67  * @exception IllegalArgumentException if <code>null</code> is specified
68  */
69 public void setName(String JavaDoc name);
70 }
71
Popular Tags