blob: 38305f8b30c7b69817a15144ea072d795ef223bc [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2000, 2008 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.aspectj.org.eclipse.jdt.core.jdom;
/**
* Represents a package declaration.
* The corresponding syntactic unit is PackageDeclaration (JLS2 7.4).
* A Package has no children, and its parent is a compilation unit.
*
* @deprecated The JDOM was made obsolete by the addition in 2.0 of the more
* powerful, fine-grained DOM/AST API found in the
* org.aspectj.org.eclipse.jdt.core.dom package.
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface IDOMPackage extends IDOMNode {
/**
* The <code>IDOMPackage</code> refinement of this <code>IDOMNode</code>
* method returns the name of this package declaration, or <code>null</code>
* if it has none. The syntax for a package name corresponds to PackageName
* as defined by PackageDeclaration (JLS2 7.4).
*
* @return the name of this package declaration, or <code>null</code>
* if it has none
*/
@Override
public String getName();
/**
* The <code>IDOMPackage</code> refinement of this <code>IDOMNode</code>
* method sets the name of this package declaration. The syntax for a package
* name corresponds to PackageName as defined by PackageDeclaration (JLS2 7.4).
* A <code>null</code> name indicates an empty package declaration; that is,
* <code>getContents</code> returns the empty string.
*
* @param name the given name
*/
@Override
public void setName(String name);
}