Eclipse JDT
Release 3.7

org.eclipse.jdt.core
Interface IClasspathAttribute


public interface IClasspathAttribute

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 newClasspathAttribute(String name, String value).

Since:
3.1
See Also:
JavaCore.newContainerEntry( org.eclipse.core.runtime.IPath containerPath, IAccessRule[] accessRules, IClasspathAttribute[] extraAttributes, boolean isExported), 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), JavaCore.newProjectEntry( org.eclipse.core.runtime.IPath path, IAccessRule[] accessRules, boolean combineAccessRestrictions, IClasspathAttribute[] extraAttributes, boolean isExported), 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), 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)
Restriction:
This interface is not intended to be implemented by clients.

Field Summary
static String JAVADOC_LOCATION_ATTRIBUTE_NAME
          Constant for the name of the javadoc location attribute.
static String OPTIONAL
          Constant for the name of the optional attribute.
 
Method Summary
 String getName()
          Returns the name of this classpath attribute.
 String getValue()
          Returns the value of this classpath attribute.
 

Field Detail

JAVADOC_LOCATION_ATTRIBUTE_NAME

static final String JAVADOC_LOCATION_ATTRIBUTE_NAME
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
See Also:
Constant Field Values

OPTIONAL

static final String OPTIONAL
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
See Also:
Constant Field Values
Method Detail

getName

String getName()
Returns the name of this classpath attribute.

Returns:
the name of this classpath attribute.
Since:
3.1

getValue

String getValue()
Returns the value of this classpath attribute.

Returns:
the value of this classpath attribute.
Since:
3.1

Eclipse JDT
Release 3.7

Guidelines for using Eclipse APIs.

Copyright (c) 2000, 2011 IBM Corporation and others. All rights reserved.