net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/jdom/IDOMImport.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  * Represents an import declaration. The corresponding syntactic unit is
  15  * ImportDeclaration (JLS2 7.5). An import has no children and its parent is a
  16  * compilation unit.
  17  * <p>
  18  * This interface is not intended to be implemented by clients.
  19  * </p>
  20  */
  21 public interface IDOMImport extends IDOMNode {
  22         /**
  23          * The <code>IDOMImport</code> refinement of this <code>IDOMNode</code>
  24          * method returns the name of this import. The syntax for an import name
  25          * corresponds to a fully qualified type name, or to an on-demand package
  26          * name as defined by ImportDeclaration (JLS2 7.5).
  27          */
  28         public String getName();
  29
  30         /**
  31          * Returns whether this import declaration ends with <code>".*"</code>.
  32          *
  33          * @return <code>true</code> if this in an on-demand import
  34          */
  35         public boolean isOnDemand();
  36
  37         /**
  38          * The <code>IDOMImport</code> refinement of this <code>IDOMNode</code>
  39          * method sets the name of this import. The syntax for an import name
  40          * corresponds to a fully qualified type name, or to an on-demand package
  41          * name as defined by ImportDeclaration (JLS2 7.5).
  42          *
  43          * @exception IllegalArgumentException
  44          *                if <code>null</code> is specified
  45          */
  46         public void setName(String name);
  47 }