org.eclipse.jdt.core.IImportDeclaration.java Source code

Introduction

Here is the source code for org.eclipse.jdt.core.IImportDeclaration.java

Source

/*******************************************************************************
 * Copyright (c) 2000, 2010 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * 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 <code>".*"</code>.
     * For example, for the statement <code>"import java.util.*"</code>,
     * this returns <code>"java.util.*"</code>.
     * For the statement <code>"import java.util.Hashtable"</code>,
     * this returns <code>"java.util.Hashtable"</code>.
     *
     * @return the name that has been imported
     */
    @Override
    String getElementName();

    /**
     * Returns the modifier flags for this import. The flags can be examined using class
     * <code>Flags</code>. 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 <code>".*"</code>.
     * @return true if the import is on-demand, false otherwise
     */
    boolean isOnDemand();
}