org.eclipse.jdt.core.IClasspathAttribute Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2005, 2015 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
* Stephan Herrmann - Contribution for
* Bug 440477 - [null] Infrastructure for feeding external annotations into compilation
*******************************************************************************/
package org.eclipse.jdt.core;
/**
* A classpath attribute defines a name/value pair that can be persisted with a classpath entry. Such an attribute
* can be created using the factory method {@link JavaCore#newClasspathAttribute(String, String) newClasspathAttribute(String name, String value)}.
*
* @see JavaCore#newContainerEntry(
* org.eclipse.core.runtime.IPath containerPath,
* IAccessRule[] accessRules,
* IClasspathAttribute[] extraAttributes,
* boolean isExported)
* @see JavaCore#newLibraryEntry(
* org.eclipse.core.runtime.IPath path,
* org.eclipse.core.runtime.IPath sourceAttachmentPath,
* org.eclipse.core.runtime.IPath sourceAttachmentRootPath,
* IAccessRule[] accessRules,
* IClasspathAttribute[] extraAttributes,
* boolean isExported)
* @see JavaCore#newProjectEntry(
* org.eclipse.core.runtime.IPath path,
* IAccessRule[] accessRules,
* boolean combineAccessRestrictions,
* IClasspathAttribute[] extraAttributes,
* boolean isExported)
* @see JavaCore#newSourceEntry(
* org.eclipse.core.runtime.IPath path,
* org.eclipse.core.runtime.IPath[] inclusionPatterns,
* org.eclipse.core.runtime.IPath[] exclusionPatterns,
* org.eclipse.core.runtime.IPath specificOutputLocation,
* IClasspathAttribute[] extraAttributes)
* @see JavaCore#newVariableEntry(
* org.eclipse.core.runtime.IPath variablePath,
* org.eclipse.core.runtime.IPath variableSourceAttachmentPath,
* org.eclipse.core.runtime.IPath variableSourceAttachmentRootPath,
* IAccessRule[] accessRules,
* IClasspathAttribute[] extraAttributes,
* boolean isExported)
* @since 3.1
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface IClasspathAttribute {
/**
* Constant for the name of the javadoc location attribute.
*
* The value for this attribute has to be the string representation of a URL.
*
* @since 3.1
*/
String JAVADOC_LOCATION_ATTRIBUTE_NAME = "javadoc_location"; //$NON-NLS-1$
/**
* Constant for the name of the index location attribute.
*
* The value for this attribute has to be the string representation of a URL.
* It should point to an existing index file in a folder or a jar. The URL can also be of platform protocol.
*
* @since 3.8
*/
String INDEX_LOCATION_ATTRIBUTE_NAME = "index_location"; //$NON-NLS-1$
/**
* Constant for the name of the encoding to be used for source attachments.
*
* The value of this attribute has to be a string representation of a valid encoding. The encoding
* for a source attachment is determined in the following order:
*
*
* - Encoding explicitly set on the source file (java or zip), i.e.
org.eclipse.core.resources.IFile#getCharset(false)
* - Encoding set on the corresponding classpath entry
* - If the source attachment is a folder, then the encoding determined by the file content if detectable
* - If the source attachment is in the workspace, then the encoding of the enclosing resources
*
*
* @see org.eclipse.core.resources.IFile#getCharset()
* @since 3.8
*/
String SOURCE_ATTACHMENT_ENCODING = "source_encoding"; //$NON-NLS-1$
/**
* Constant for the name of the ignore optional compile problems attribute.
* This attribute is valid only for classpath entries describing source folders.
* The possible values for this attribute are "true"
or
* "false"
. When not present, "false"
is assumed.
* If the value of this attribute is "true"
, all optional problems
* from the source folder described by this classpath entry will not be reported
* by the compiler.
*
* @since 3.8
*/
String IGNORE_OPTIONAL_PROBLEMS = "ignore_optional_problems"; //$NON-NLS-1$
/**
* Constant for the name of the optional attribute. The possible values
* for this attribute are "true"
or "false"
.
* When not present, "false"
is assumed.
* If the value of this attribute is "true"
, the classpath entry
* is optional. If the underlying resource or jar file doesn't exist, no error
* is reported and the classpath entry is ignored.
*
* @since 3.2
*/
String OPTIONAL = "optional"; //$NON-NLS-1$
/**
* Constant for the name of the external annotation path attribute.
*
* The value for this attribute has to be the string representation of a path.
* It should point to an existing directory where external annotations can be
* found to support annotation based null analysis involving 3rd party libraries.
*
* @since 3.11
*/
String EXTERNAL_ANNOTATION_PATH = "annotationpath"; //$NON-NLS-1$
/**
* Returns the name of this classpath attribute.
*
* @return the name of this classpath attribute.
* @since 3.1
*/
String getName();
/**
* Returns the value of this classpath attribute.
*
* @return the value of this classpath attribute.
* @since 3.1
*/
String getValue();
}