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  * Represents a package declaration.
  14  * The corresponding syntactic unit is PackageDeclaration (JLS2 7.4).
  15  * A Package has no children, and its parent is a compilation unit.
  16  * <p>
  17  * This interface is not intended to be implemented by clients.
  18  * </p>
  19  */
  20 public interface IDOMPackage extends IDOMNode {
  21 /**
  22  * The <code>IDOMPackage</code> refinement of this <code>IDOMNode</code>
  23  * method returns the name of this package declaration, or <code>null</code>
  24  * if it has none. The syntax for a package name corresponds to PackageName
  25  * as defined by PackageDeclaration (JLS2 7.4).
  26  */
  27 public String getName();
  28 /**
  29  * The <code>IDOMPackage</code> refinement of this <code>IDOMNode</code>
  30  * method sets the name of this package declaration. The syntax for a package
  31  * name corresponds to PackageName as defined by PackageDeclaration (JLS2 7.4).
  32  * A <code>null</code> name indicates an empty package declaration; that is,
  33  * <code>getContents</code> returns the empty string.
  34  */
  35 public void setName(String name);
  36 }