net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/jdom/IDOMPackage.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 a package declaration. The corresponding syntactic unit is
  15  * PackageDeclaration (JLS2 7.4). A Package 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 IDOMPackage extends IDOMNode {
  22         /**
  23          * The <code>IDOMPackage</code> refinement of this <code>IDOMNode</code>
  24          * method returns the name of this package declaration, or <code>null</code>
  25          * if it has none. The syntax for a package name corresponds to PackageName
  26          * as defined by PackageDeclaration (JLS2 7.4).
  27          */
  28         public String getName();
  29
  30         /**
  31          * The <code>IDOMPackage</code> refinement of this <code>IDOMNode</code>
  32          * method sets the name of this package declaration. The syntax for a
  33          * package name corresponds to PackageName as defined by PackageDeclaration
  34          * (JLS2 7.4). A <code>null</code> name indicates an empty package
  35          * declaration; that is, <code>getContents</code> returns the empty
  36          * string.
  37          */
  38         public void setName(String name);
  39 }