org.eclipse.jdt.core.IImportDeclaration Maven / Gradle / Ivy

/*******************************************************************************
 * Copyright (c) 2000, 2010 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
 *     IBM Corporation - added J2SE 1.5 support
 *******************************************************************************/
package org.eclipse.jdt.core;

/**
 * Represents an import declaration in Java compilation unit.
 *
 * @noimplement This interface is not intended to be implemented by clients.
 */
public interface IImportDeclaration extends IJavaElement, ISourceReference, ISourceManipulation {
/**
 * Returns the name that has been imported.
 * For an on-demand import, this includes the trailing ".*".
 * For example, for the statement "import java.util.*",
 * this returns "java.util.*".
 * For the statement "import java.util.Hashtable",
 * this returns "java.util.Hashtable".
 *
 * @return the name that has been imported
 */
String getElementName();
/**
 * Returns the modifier flags for this import. The flags can be examined using class
 * Flags. Only the static flag is meaningful for import declarations.
 *
 * @return the modifier flags for this import
 * @exception JavaModelException if this element does not exist or if an
 *      exception occurs while accessing its corresponding resource.
 * @see Flags
 * @since 3.0
 */
int getFlags() throws JavaModelException;
/**
 * Returns whether the import is on-demand. An import is on-demand if it ends
 * with ".*".
 * @return true if the import is on-demand, false otherwise
 */
boolean isOnDemand();
}