|
Eclipse JDT Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.core.runtime.Plugin
org.eclipse.jdt.core.JavaCore
The plug-in runtime class for the Java model plug-in containing the core (UI-free) support for Java projects.
Like all plug-in runtime classes (subclasses of Plugin
), this
class is automatically instantiated by the platform when the plug-in gets
activated. Clients must not attempt to instantiate plug-in runtime classes
directly.
The single instance of this class can be accessed from any plug-in declaring
the Java model plug-in as a prerequisite via
JavaCore.getJavaCore()
. The Java model plug-in will be activated
automatically if not already active.
Field Summary | |
---|---|
static String |
ABORT
Possible configurable option value. |
protected static String |
ATT_HANDLE_ID
Name of the handle id attribute in a Java marker. |
static String |
BUILDER_ID
The identifier for the Java builder (value "org.eclipse.jdt.core.javabuilder" ). |
static String |
CLEAN
Possible configurable option value. |
static String |
CLEAR_ALL
Possible configurable option value. |
static String |
CODEASSIST_ARGUMENT_PREFIXES
Possible configurable option ID. |
static String |
CODEASSIST_ARGUMENT_SUFFIXES
Possible configurable option ID. |
static String |
CODEASSIST_DISCOURAGED_REFERENCE_CHECK
Possible configurable option ID. |
static String |
CODEASSIST_FIELD_PREFIXES
Possible configurable option ID. |
static String |
CODEASSIST_FIELD_SUFFIXES
Possible configurable option ID. |
static String |
CODEASSIST_FORBIDDEN_REFERENCE_CHECK
Possible configurable option ID. |
static String |
CODEASSIST_IMPLICIT_QUALIFICATION
Possible configurable option ID. |
static String |
CODEASSIST_LOCAL_PREFIXES
Possible configurable option ID. |
static String |
CODEASSIST_LOCAL_SUFFIXES
Possible configurable option ID. |
static String |
CODEASSIST_STATIC_FIELD_PREFIXES
Possible configurable option ID. |
static String |
CODEASSIST_STATIC_FIELD_SUFFIXES
Possible configurable option ID. |
static String |
CODEASSIST_VISIBILITY_CHECK
Possible configurable option ID. |
static String |
COMPACT
Possible configurable option value. |
static String |
COMPILER_CODEGEN_INLINE_JSR_BYTECODE
Possible configurable option ID. |
static String |
COMPILER_CODEGEN_TARGET_PLATFORM
Possible configurable option ID. |
static String |
COMPILER_CODEGEN_UNUSED_LOCAL
Possible configurable option ID. |
static String |
COMPILER_COMPLIANCE
Possible configurable option ID. |
static String |
COMPILER_DOC_COMMENT_SUPPORT
Possible configurable option ID. |
static String |
COMPILER_LINE_NUMBER_ATTR
Possible configurable option ID. |
static String |
COMPILER_LOCAL_VARIABLE_ATTR
Possible configurable option ID. |
static String |
COMPILER_PB_ANNOTATION_SUPER_INTERFACE
Possible configurable option ID. |
static String |
COMPILER_PB_ASSERT_IDENTIFIER
Possible configurable option ID. |
static String |
COMPILER_PB_AUTOBOXING
Possible configurable option ID. |
static String |
COMPILER_PB_BOOLEAN_METHOD_THROWING_EXCEPTION
Possible configurable option ID. |
static String |
COMPILER_PB_CHAR_ARRAY_IN_STRING_CONCATENATION
Possible configurable option ID. |
static String |
COMPILER_PB_DEPRECATION
Possible configurable option ID. |
static String |
COMPILER_PB_DEPRECATION_IN_DEPRECATED_CODE
Possible configurable option ID. |
static String |
COMPILER_PB_DEPRECATION_WHEN_OVERRIDING_DEPRECATED_METHOD
Possible configurable option ID. |
static String |
COMPILER_PB_DISCOURAGED_REFERENCE
Possible configurable option ID. |
static String |
COMPILER_PB_EMPTY_STATEMENT
Possible configurable option ID. |
static String |
COMPILER_PB_ENUM_IDENTIFIER
Possible configurable option ID. |
static String |
COMPILER_PB_FIELD_HIDING
Possible configurable option ID. |
static String |
COMPILER_PB_FINAL_PARAMETER_BOUND
Possible configurable option ID. |
static String |
COMPILER_PB_FINALLY_BLOCK_NOT_COMPLETING
Possible configurable option ID. |
static String |
COMPILER_PB_FORBIDDEN_REFERENCE
Possible configurable option ID. |
static String |
COMPILER_PB_HIDDEN_CATCH_BLOCK
Possible configurable option ID. |
static String |
COMPILER_PB_INCOMPATIBLE_NON_INHERITED_INTERFACE_METHOD
Possible configurable option ID. |
static String |
COMPILER_PB_INCOMPLETE_ENUM_SWITCH
Possible configurable option ID. |
static String |
COMPILER_PB_INCONSISTENT_NULL_CHECK
Possible configurable option ID. |
static String |
COMPILER_PB_INDIRECT_STATIC_ACCESS
Possible configurable option ID. |
static String |
COMPILER_PB_INVALID_IMPORT
Deprecated. - discontinued since turning off would violate language specs |
static String |
COMPILER_PB_INVALID_JAVADOC
Possible configurable option ID. |
static String |
COMPILER_PB_INVALID_JAVADOC_TAGS
Possible configurable option ID. |
static String |
COMPILER_PB_INVALID_JAVADOC_TAGS__DEPRECATED_REF
Possible configurable option ID. |
static String |
COMPILER_PB_INVALID_JAVADOC_TAGS__NOT_VISIBLE_REF
Possible configurable option ID. |
static String |
COMPILER_PB_INVALID_JAVADOC_TAGS_VISIBILITY
Possible configurable option ID. |
static String |
COMPILER_PB_LOCAL_VARIABLE_HIDING
Possible configurable option ID. |
static String |
COMPILER_PB_MAX_PER_UNIT
Possible configurable option ID. |
static String |
COMPILER_PB_METHOD_WITH_CONSTRUCTOR_NAME
Possible configurable option ID. |
static String |
COMPILER_PB_MISSING_DEPRECATED_ANNOTATION
Possible configurable option ID. |
static String |
COMPILER_PB_MISSING_JAVADOC_COMMENTS
Possible configurable option ID. |
static String |
COMPILER_PB_MISSING_JAVADOC_COMMENTS_OVERRIDING
Possible configurable option ID. |
static String |
COMPILER_PB_MISSING_JAVADOC_COMMENTS_VISIBILITY
Possible configurable option ID. |
static String |
COMPILER_PB_MISSING_JAVADOC_TAGS
Possible configurable option ID. |
static String |
COMPILER_PB_MISSING_JAVADOC_TAGS_OVERRIDING
Possible configurable option ID. |
static String |
COMPILER_PB_MISSING_JAVADOC_TAGS_VISIBILITY
Possible configurable option ID. |
static String |
COMPILER_PB_MISSING_OVERRIDE_ANNOTATION
Possible configurable option ID. |
static String |
COMPILER_PB_MISSING_SERIAL_VERSION
Possible configurable option ID. |
static String |
COMPILER_PB_NO_EFFECT_ASSIGNMENT
Possible configurable option ID. |
static String |
COMPILER_PB_NON_NLS_STRING_LITERAL
Possible configurable option ID. |
static String |
COMPILER_PB_OVERRIDING_PACKAGE_DEFAULT_METHOD
Possible configurable option ID. |
static String |
COMPILER_PB_POSSIBLE_ACCIDENTAL_BOOLEAN_ASSIGNMENT
Possible configurable option ID. |
static String |
COMPILER_PB_SPECIAL_PARAMETER_HIDING_FIELD
Possible configurable option ID. |
static String |
COMPILER_PB_STATIC_ACCESS_RECEIVER
Possible configurable option ID. |
static String |
COMPILER_PB_SUPPRESS_WARNINGS
Possible configurable option ID. |
static String |
COMPILER_PB_SYNTHETIC_ACCESS_EMULATION
Possible configurable option ID. |
static String |
COMPILER_PB_TYPE_PARAMETER_HIDING
Possible configurable option ID. |
static String |
COMPILER_PB_UNCHECKED_TYPE_OPERATION
Possible configurable option ID. |
static String |
COMPILER_PB_UNDOCUMENTED_EMPTY_BLOCK
Possible configurable option ID. |
static String |
COMPILER_PB_UNHANDLED_WARNING_TOKEN
Possible configurable option ID. |
static String |
COMPILER_PB_UNNECESSARY_ELSE
Possible configurable option ID. |
static String |
COMPILER_PB_UNNECESSARY_TYPE_CHECK
Possible configurable option ID. |
static String |
COMPILER_PB_UNQUALIFIED_FIELD_ACCESS
Possible configurable option ID. |
static String |
COMPILER_PB_UNREACHABLE_CODE
Deprecated. - discontinued since turning off would violate language specs |
static String |
COMPILER_PB_UNSAFE_TYPE_OPERATION
Deprecated. - got renamed into COMPILER_PB_UNCHECKED_TYPE_OPERATION |
static String |
COMPILER_PB_UNUSED_DECLARED_THROWN_EXCEPTION
Possible configurable option ID. |
static String |
COMPILER_PB_UNUSED_DECLARED_THROWN_EXCEPTION_WHEN_OVERRIDING
Possible configurable option ID. |
static String |
COMPILER_PB_UNUSED_IMPORT
Possible configurable option ID. |
static String |
COMPILER_PB_UNUSED_LOCAL
Possible configurable option ID. |
static String |
COMPILER_PB_UNUSED_PARAMETER
Possible configurable option ID. |
static String |
COMPILER_PB_UNUSED_PARAMETER_WHEN_IMPLEMENTING_ABSTRACT
Possible configurable option ID. |
static String |
COMPILER_PB_UNUSED_PARAMETER_WHEN_OVERRIDING_CONCRETE
Possible configurable option ID. |
static String |
COMPILER_PB_UNUSED_PRIVATE_MEMBER
Possible configurable option ID. |
static String |
COMPILER_PB_VARARGS_ARGUMENT_NEED_CAST
Possible configurable option ID. |
static String |
COMPILER_SOURCE
Possible configurable option ID. |
static String |
COMPILER_SOURCE_FILE_ATTR
Possible configurable option ID. |
static String |
COMPILER_TASK_CASE_SENSITIVE
Possible configurable option ID. |
static String |
COMPILER_TASK_PRIORITIES
Possible configurable option ID. |
static String |
COMPILER_TASK_PRIORITY_HIGH
Possible configurable option value for COMPILER_TASK_PRIORITIES. |
static String |
COMPILER_TASK_PRIORITY_LOW
Possible configurable option value for COMPILER_TASK_PRIORITIES. |
static String |
COMPILER_TASK_PRIORITY_NORMAL
Possible configurable option value for COMPILER_TASK_PRIORITIES. |
static String |
COMPILER_TASK_TAGS
Possible configurable option ID. |
static String |
COMPUTE
Possible configurable option value. |
static String |
CORE_CIRCULAR_CLASSPATH
Possible configurable option ID. |
static String |
CORE_ENABLE_CLASSPATH_EXCLUSION_PATTERNS
Possible configurable option ID. |
static String |
CORE_ENABLE_CLASSPATH_MULTIPLE_OUTPUT_LOCATIONS
Possible configurable option ID. |
static String |
CORE_ENCODING
Possible configurable option ID. |
static String |
CORE_INCOMPATIBLE_JDK_LEVEL
Possible configurable option ID. |
static String |
CORE_INCOMPLETE_CLASSPATH
Possible configurable option ID. |
static String |
CORE_JAVA_BUILD_CLEAN_OUTPUT_FOLDER
Possible configurable option ID. |
static String |
CORE_JAVA_BUILD_DUPLICATE_RESOURCE
Possible configurable option ID. |
static String |
CORE_JAVA_BUILD_INVALID_CLASSPATH
Possible configurable option ID. |
static String |
CORE_JAVA_BUILD_ORDER
Possible configurable option ID. |
static String |
CORE_JAVA_BUILD_RESOURCE_COPY_FILTER
Possible configurable option ID. |
static String |
DEFAULT
Possible configurable option value. |
static String |
DEFAULT_TASK_PRIORITIES
Default task priority |
static String |
DEFAULT_TASK_PRIORITY
Deprecated. - should use #DEFAULT_TASK_PRIORITIES instead |
static String |
DEFAULT_TASK_TAG
Deprecated. - should use #DEFAULT_TASK_TAGS instead |
static String |
DEFAULT_TASK_TAGS
Default task tag |
static String |
DISABLED
Possible configurable option value. |
static String |
DO_NOT_GENERATE
Possible configurable option value. |
static String |
DO_NOT_INSERT
Possible configurable option value. |
static String |
ENABLED
Possible configurable option value. |
static String |
ERROR
Possible configurable option value. |
static String |
FORMATTER_CLEAR_BLANK_LINES
Deprecated. Use DefaultCodeFormatterConstants.FORMATTER_NUMBER_OF_EMPTY_LINES_TO_PRESERVE instead |
static String |
FORMATTER_COMPACT_ASSIGNMENT
Deprecated. Use DefaultCodeFormatterConstants.FORMATTER_INSERT_SPACE_BEFORE_ASSIGNMENT_OPERATOR instead |
static String |
FORMATTER_LINE_SPLIT
Deprecated. Use DefaultCodeFormatterConstants.FORMATTER_LINE_SPLIT instead |
static String |
FORMATTER_NEWLINE_CONTROL
Deprecated. Use DefaultCodeFormatterConstants.FORMATTER_INSERT_NEW_LINE_BEFORE_CATCH_IN_TRY_STATEMENT ,
DefaultCodeFormatterConstants.FORMATTER_INSERT_NEW_LINE_BEFORE_ELSE_IN_IF_STATEMENT ,
DefaultCodeFormatterConstants.FORMATTER_INSERT_NEW_LINE_BEFORE_FINALLY_IN_TRY_STATEMENT ,
DefaultCodeFormatterConstants.FORMATTER_INSERT_NEW_LINE_BEFORE_WHILE_IN_DO_STATEMENT instead. |
static String |
FORMATTER_NEWLINE_ELSE_IF
Deprecated. Use DefaultCodeFormatterConstants.FORMATTER_COMPACT_ELSE_IF instead |
static String |
FORMATTER_NEWLINE_EMPTY_BLOCK
Deprecated. Use DefaultCodeFormatterConstants.FORMATTER_INSERT_NEW_LINE_IN_EMPTY_BLOCK instead |
static String |
FORMATTER_NEWLINE_OPENING_BRACE
Deprecated. Use DefaultCodeFormatterConstants.FORMATTER_BRACE_POSITION_FOR_ANONYMOUS_TYPE_DECLARATION ,
DefaultCodeFormatterConstants.FORMATTER_BRACE_POSITION_FOR_BLOCK ,
DefaultCodeFormatterConstants.FORMATTER_BRACE_POSITION_FOR_CONSTRUCTOR_DECLARATION ,
DefaultCodeFormatterConstants.FORMATTER_BRACE_POSITION_FOR_METHOD_DECLARATION ,
DefaultCodeFormatterConstants.FORMATTER_BRACE_POSITION_FOR_SWITCH ,
DefaultCodeFormatterConstants.FORMATTER_BRACE_POSITION_FOR_TYPE_DECLARATION instead |
static String |
FORMATTER_SPACE_CASTEXPRESSION
Deprecated. Use DefaultCodeFormatterConstants.FORMATTER_INSERT_SPACE_AFTER_CLOSING_PAREN_IN_CAST instead |
static String |
FORMATTER_TAB_CHAR
Deprecated. Use DefaultCodeFormatterConstants.FORMATTER_TAB_CHAR } instead |
static String |
FORMATTER_TAB_SIZE
Deprecated. Use DefaultCodeFormatterConstants.FORMATTER_TAB_SIZE instead |
static String |
GENERATE
Possible configurable option value. |
static String |
IGNORE
Possible configurable option value. |
static String |
INSERT
Possible configurable option value. |
static String |
MODEL_ID
The identifier for the Java model (value "org.eclipse.jdt.core.javamodel" ). |
static String |
NATURE_ID
The identifier for the Java nature (value "org.eclipse.jdt.core.javanature" ).
|
static String |
NEVER
Possible configurable option value. |
static String |
NORMAL
Possible configurable option value. |
static String |
OPTIMIZE_OUT
Possible configurable option value. |
static String |
PLUGIN_ID
The plug-in identifier of the Java core support (value "org.eclipse.jdt.core" ). |
static String |
PRESERVE
Possible configurable option value. |
static String |
PRESERVE_ONE
Possible configurable option value. |
static String |
PRIVATE
Possible configurable option value. |
static String |
PROTECTED
Possible configurable option value. |
static String |
PUBLIC
Possible configurable option value. |
static String |
SPACE
Possible configurable option value. |
static String |
TAB
Possible configurable option value. |
static String |
USER_LIBRARY_CONTAINER_ID
Name of the User Library Container id. |
static String |
VERSION_1_1
Possible configurable option value. |
static String |
VERSION_1_2
Possible configurable option value. |
static String |
VERSION_1_3
Possible configurable option value. |
static String |
VERSION_1_4
Possible configurable option value. |
static String |
VERSION_1_5
Possible configurable option value. |
static String |
WARNING
Possible configurable option value. |
Fields inherited from class org.eclipse.core.runtime.Plugin |
---|
PLUGIN_PREFERENCE_SCOPE, PREFERENCES_DEFAULT_OVERRIDE_BASE_NAME, PREFERENCES_DEFAULT_OVERRIDE_FILE_NAME |
Constructor Summary | |
---|---|
JavaCore()
Creates the Java core plug-in. |
Method Summary | |
---|---|
static void |
addElementChangedListener(IElementChangedListener listener)
Adds the given listener for changes to Java elements. |
static void |
addElementChangedListener(IElementChangedListener listener,
int eventMask)
Adds the given listener for changes to Java elements. |
static void |
addJavaElementMarkerAttributes(Map attributes,
IJavaElement element)
Configures the given marker attribute map for the given Java element. |
static void |
addPreProcessingResourceChangedListener(IResourceChangeListener listener)
Adds the given listener for POST_CHANGE resource change events to the Java core. |
void |
configureJavaElementMarker(IMarker marker,
IJavaElement element)
Configures the given marker for the given Java element. |
static IJavaElement |
create(IFile file)
Returns the Java element corresponding to the given file, or null if unable to associate the given file
with a Java element.
|
static IJavaElement |
create(IFolder folder)
Returns the package fragment or package fragment root corresponding to the given folder, or null if unable to associate the given folder with a Java element.
|
static IJavaProject |
create(IProject project)
Returns the Java project corresponding to the given project. |
static IJavaElement |
create(IResource resource)
Returns the Java element corresponding to the given resource, or null if unable to associate the given resource
with a Java element.
|
static IJavaModel |
create(IWorkspaceRoot root)
Returns the Java model. |
static IJavaElement |
create(String handleIdentifier)
Returns the Java model element corresponding to the given handle identifier generated by IJavaElement.getHandleIdentifier() , or
null if unable to create the associated element. |
static IJavaElement |
create(String handleIdentifier,
WorkingCopyOwner owner)
Returns the Java model element corresponding to the given handle identifier generated by IJavaElement.getHandleIdentifier() , or
null if unable to create the associated element.
|
static IClassFile |
createClassFileFrom(IFile file)
Creates and returns a class file element for the given .class file. |
static ICompilationUnit |
createCompilationUnitFrom(IFile file)
Creates and returns a compilation unit element for the given .java file. |
static IPackageFragmentRoot |
createJarPackageFragmentRootFrom(IFile file)
Creates and returns a handle for the given JAR file. |
static IClasspathContainer |
getClasspathContainer(IPath containerPath,
IJavaProject project)
Answers the project specific value for a given classpath container. |
static ClasspathContainerInitializer |
getClasspathContainerInitializer(String containerID)
Helper method finding the classpath container initializer registered for a given classpath container ID or null if none was found while iterating over the contributions to extension point to
the extension point "org.eclipse.jdt.core.classpathContainerInitializer".
|
static IPath |
getClasspathVariable(String variableName)
Returns the path held in the given classpath variable. |
static ClasspathVariableInitializer |
getClasspathVariableInitializer(String variable)
Helper method finding the classpath variable initializer registered for a given classpath variable name or null if none was found while iterating over the contributions to extension point to
the extension point "org.eclipse.jdt.core.classpathVariableInitializer".
|
static String[] |
getClasspathVariableNames()
Returns the names of all known classpath variables. |
static Hashtable |
getDefaultOptions()
Returns a table of all known configurable options with their default values. |
static String |
getEncoding()
Returns the workspace root default charset encoding. |
static JavaCore |
getJavaCore()
Returns the single instance of the Java core plug-in runtime class. |
static String |
getOption(String optionName)
Helper method for returning one option value only. |
static Hashtable |
getOptions()
Returns the table of the current options. |
static Plugin |
getPlugin()
Returns the single instance of the Java core plug-in runtime class. |
static IClasspathEntry |
getResolvedClasspathEntry(IClasspathEntry entry)
This is a helper method, which returns the resolved classpath entry denoted by a given entry (if it is a variable entry). |
static IPath |
getResolvedVariablePath(IPath variablePath)
Resolve a variable path (helper method). |
static IWorkingCopy[] |
getSharedWorkingCopies(IBufferFactory factory)
Deprecated. - should use #getWorkingCopies(WorkingCopyOwner) instead |
static String[] |
getUserLibraryNames()
Returns the names of all defined user libraries. |
static ICompilationUnit[] |
getWorkingCopies(WorkingCopyOwner owner)
Returns the working copies that have the given owner. |
static void |
initializeAfterLoad(IProgressMonitor monitor)
Initializes JavaCore internal structures to allow subsequent operations (such as the ones that need a resolved classpath) to run full speed. |
static boolean |
isReferencedBy(IJavaElement element,
IMarker marker)
Returns whether the given marker references the given Java element. |
static boolean |
isReferencedBy(IJavaElement element,
IMarkerDelta markerDelta)
Returns whether the given marker delta references the given Java element. |
static IAccessRule |
newAccessRule(IPath filePattern,
int kind)
Creates and returns a new access rule with the given file pattern and kind. |
static IClasspathAttribute |
newClasspathAttribute(String name,
String value)
Creates and returns a new classpath attribute with the given name and the given value. |
static IClasspathEntry |
newContainerEntry(IPath containerPath)
Creates and returns a new classpath entry of kind CPE_CONTAINER
for the given path. |
static IClasspathEntry |
newContainerEntry(IPath containerPath,
boolean isExported)
Creates and returns a new classpath entry of kind CPE_CONTAINER
for the given path. |
static IClasspathEntry |
newContainerEntry(IPath containerPath,
IAccessRule[] accessRules,
IClasspathAttribute[] extraAttributes,
boolean isExported)
Creates and returns a new classpath entry of kind CPE_CONTAINER
for the given path. |
static IClasspathEntry |
newLibraryEntry(IPath path,
IPath sourceAttachmentPath,
IPath sourceAttachmentRootPath)
Creates and returns a new non-exported classpath entry of kind CPE_LIBRARY for the
JAR or folder identified by the given absolute path. |
static IClasspathEntry |
newLibraryEntry(IPath path,
IPath sourceAttachmentPath,
IPath sourceAttachmentRootPath,
boolean isExported)
Creates and returns a new classpath entry of kind CPE_LIBRARY for the JAR or folder
identified by the given absolute path. |
static IClasspathEntry |
newLibraryEntry(IPath path,
IPath sourceAttachmentPath,
IPath sourceAttachmentRootPath,
IAccessRule[] accessRules,
IClasspathAttribute[] extraAttributes,
boolean isExported)
Creates and returns a new classpath entry of kind CPE_LIBRARY for the JAR or folder
identified by the given absolute path. |
static IClasspathEntry |
newProjectEntry(IPath path)
Creates and returns a new non-exported classpath entry of kind CPE_PROJECT
for the project identified by the given absolute path.
|
static IClasspathEntry |
newProjectEntry(IPath path,
boolean isExported)
Creates and returns a new classpath entry of kind CPE_PROJECT
for the project identified by the given absolute path.
|
static IClasspathEntry |
newProjectEntry(IPath path,
IAccessRule[] accessRules,
boolean combineAccessRules,
IClasspathAttribute[] extraAttributes,
boolean isExported)
Creates and returns a new classpath entry of kind CPE_PROJECT
for the project identified by the given absolute path.
|
static IRegion |
newRegion()
Returns a new empty region. |
static IClasspathEntry |
newSourceEntry(IPath path)
Creates and returns a new classpath entry of kind CPE_SOURCE
for all files in the project's source folder identified by the given
absolute workspace-relative path.
|
static IClasspathEntry |
newSourceEntry(IPath path,
IPath[] exclusionPatterns)
Creates and returns a new classpath entry of kind CPE_SOURCE
for the project's source folder identified by the given absolute
workspace-relative path but excluding all source files with paths
matching any of the given patterns.
|
static IClasspathEntry |
newSourceEntry(IPath path,
IPath[] exclusionPatterns,
IPath specificOutputLocation)
Creates and returns a new classpath entry of kind CPE_SOURCE
for the project's source folder identified by the given absolute
workspace-relative path but excluding all source files with paths
matching any of the given patterns, and associated with a specific output location
(that is, ".class" files are not going to the project default output location).
|
static IClasspathEntry |
newSourceEntry(IPath path,
IPath[] inclusionPatterns,
IPath[] exclusionPatterns,
IPath specificOutputLocation)
Creates and returns a new classpath entry of kind CPE_SOURCE
for the project's source folder identified by the given absolute
workspace-relative path but excluding all source files with paths
matching any of the given patterns, and associated with a specific output location
(that is, ".class" files are not going to the project default output location).
|
static IClasspathEntry |
newSourceEntry(IPath path,
IPath[] inclusionPatterns,
IPath[] exclusionPatterns,
IPath specificOutputLocation,
IClasspathAttribute[] extraAttributes)
Creates and returns a new classpath entry of kind CPE_SOURCE
for the project's source folder identified by the given absolute
workspace-relative path using the given inclusion and exclusion patterns
to determine which source files are included, and the given output path
to control the output location of generated files.
|
static ITypeHierarchy |
newTypeHierarchy(IRegion region,
WorkingCopyOwner owner,
IProgressMonitor monitor)
Creates and returns a type hierarchy for all types in the given region, considering subtypes within that region and considering types in the working copies with the given owner. |
static IClasspathEntry |
newVariableEntry(IPath variablePath,
IPath variableSourceAttachmentPath,
IPath sourceAttachmentRootPath)
Creates and returns a new non-exported classpath entry of kind CPE_VARIABLE
for the given path. |
static IClasspathEntry |
newVariableEntry(IPath variablePath,
IPath variableSourceAttachmentPath,
IPath variableSourceAttachmentRootPath,
boolean isExported)
Creates and returns a new classpath entry of kind CPE_VARIABLE
for the given path. |
static IClasspathEntry |
newVariableEntry(IPath variablePath,
IPath variableSourceAttachmentPath,
IPath variableSourceAttachmentRootPath,
IAccessRule[] accessRules,
IClasspathAttribute[] extraAttributes,
boolean isExported)
Creates and returns a new non-exported classpath entry of kind CPE_VARIABLE
for the given path. |
static void |
removeClasspathVariable(String variableName)
Deprecated. - use version with extra IProgressMonitor |
static void |
removeClasspathVariable(String variableName,
IProgressMonitor monitor)
Removed the given classpath variable. |
static void |
removeElementChangedListener(IElementChangedListener listener)
Removes the given element changed listener. |
static void |
removePreProcessingResourceChangedListener(IResourceChangeListener listener)
Removes the given pre-processing resource changed listener. |
static void |
run(IWorkspaceRunnable action,
IProgressMonitor monitor)
Runs the given action as an atomic Java model operation. |
static void |
run(IWorkspaceRunnable action,
ISchedulingRule rule,
IProgressMonitor monitor)
Runs the given action as an atomic Java model operation. |
static void |
setClasspathContainer(IPath containerPath,
IJavaProject[] affectedProjects,
IClasspathContainer[] respectiveContainers,
IProgressMonitor monitor)
Bind a container reference path to some actual containers ( IClasspathContainer ).
|
static void |
setClasspathVariable(String variableName,
IPath path)
Deprecated. - use API with IProgressMonitor |
static void |
setClasspathVariable(String variableName,
IPath path,
IProgressMonitor monitor)
Sets the value of the given classpath variable. |
static void |
setClasspathVariables(String[] variableNames,
IPath[] paths,
IProgressMonitor monitor)
Sets the values of all the given classpath variables at once. |
static void |
setOptions(Hashtable newOptions)
Sets the current table of options. |
void |
start(BundleContext context)
|
void |
stop(BundleContext context)
|
Methods inherited from class org.eclipse.core.runtime.Plugin |
---|
find, find, getBundle, getDescriptor, getLog, getPluginPreferences, getStateLocation, initializeDefaultPluginPreferences, internalInitializeDefaultPluginPreferences, isDebugging, openStream, openStream, savePluginPreferences, setDebugging, shutdown, startup, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final String PLUGIN_ID
"org.eclipse.jdt.core"
).
public static final String BUILDER_ID
"org.eclipse.jdt.core.javabuilder"
).
public static final String MODEL_ID
"org.eclipse.jdt.core.javamodel"
).
public static final String NATURE_ID
"org.eclipse.jdt.core.javanature"
).
The presence of this nature on a project indicates that it is
Java-capable.
IProject.hasNature(java.lang.String)
,
Constant Field Valuesprotected static final String ATT_HANDLE_ID
public static final String USER_LIBRARY_CONTAINER_ID
public static final String COMPILER_LOCAL_VARIABLE_ATTR
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_LINE_NUMBER_ATTR
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_SOURCE_FILE_ATTR
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_CODEGEN_UNUSED_LOCAL
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_CODEGEN_TARGET_PLATFORM
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_CODEGEN_INLINE_JSR_BYTECODE
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_DOC_COMMENT_SUPPORT
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_UNREACHABLE_CODE
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_INVALID_IMPORT
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_OVERRIDING_PACKAGE_DEFAULT_METHOD
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_METHOD_WITH_CONSTRUCTOR_NAME
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_DEPRECATION
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_DEPRECATION_IN_DEPRECATED_CODE
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_DEPRECATION_WHEN_OVERRIDING_DEPRECATED_METHOD
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_HIDDEN_CATCH_BLOCK
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_UNUSED_LOCAL
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_UNUSED_PARAMETER
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_UNUSED_PARAMETER_WHEN_IMPLEMENTING_ABSTRACT
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_UNUSED_PARAMETER_WHEN_OVERRIDING_CONCRETE
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_UNUSED_IMPORT
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_SYNTHETIC_ACCESS_EMULATION
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_NON_NLS_STRING_LITERAL
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_ASSERT_IDENTIFIER
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_ENUM_IDENTIFIER
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_STATIC_ACCESS_RECEIVER
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_INDIRECT_STATIC_ACCESS
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_NO_EFFECT_ASSIGNMENT
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_INCOMPATIBLE_NON_INHERITED_INTERFACE_METHOD
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_UNUSED_PRIVATE_MEMBER
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_LOCAL_VARIABLE_HIDING
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_SPECIAL_PARAMETER_HIDING_FIELD
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_FIELD_HIDING
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_TYPE_PARAMETER_HIDING
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_POSSIBLE_ACCIDENTAL_BOOLEAN_ASSIGNMENT
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_EMPTY_STATEMENT
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_BOOLEAN_METHOD_THROWING_EXCEPTION
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_UNNECESSARY_TYPE_CHECK
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_UNNECESSARY_ELSE
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_UNDOCUMENTED_EMPTY_BLOCK
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_FINALLY_BLOCK_NOT_COMPLETING
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_UNUSED_DECLARED_THROWN_EXCEPTION
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_UNUSED_DECLARED_THROWN_EXCEPTION_WHEN_OVERRIDING
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_UNQUALIFIED_FIELD_ACCESS
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_UNSAFE_TYPE_OPERATION
COMPILER_PB_UNCHECKED_TYPE_OPERATION
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_UNCHECKED_TYPE_OPERATION
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_FINAL_PARAMETER_BOUND
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_MISSING_SERIAL_VERSION
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_VARARGS_ARGUMENT_NEED_CAST
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_AUTOBOXING
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_ANNOTATION_SUPER_INTERFACE
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_MISSING_OVERRIDE_ANNOTATION
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_MISSING_DEPRECATED_ANNOTATION
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_INCOMPLETE_ENUM_SWITCH
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_INCONSISTENT_NULL_CHECK
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_INVALID_JAVADOC
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_INVALID_JAVADOC_TAGS
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_INVALID_JAVADOC_TAGS__DEPRECATED_REF
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_INVALID_JAVADOC_TAGS__NOT_VISIBLE_REF
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_INVALID_JAVADOC_TAGS_VISIBILITY
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_MISSING_JAVADOC_TAGS
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_MISSING_JAVADOC_TAGS_VISIBILITY
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_MISSING_JAVADOC_TAGS_OVERRIDING
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_MISSING_JAVADOC_COMMENTS
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_MISSING_JAVADOC_COMMENTS_VISIBILITY
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_MISSING_JAVADOC_COMMENTS_OVERRIDING
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_CHAR_ARRAY_IN_STRING_CONCATENATION
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_MAX_PER_UNIT
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_SOURCE
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_COMPLIANCE
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_TASK_PRIORITIES
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_TASK_PRIORITY_HIGH
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_TASK_PRIORITY_LOW
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_TASK_PRIORITY_NORMAL
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_TASK_TAGS
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_TASK_CASE_SENSITIVE
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_FORBIDDEN_REFERENCE
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_DISCOURAGED_REFERENCE
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_SUPPRESS_WARNINGS
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPILER_PB_UNHANDLED_WARNING_TOKEN
getDefaultOptions()
,
Constant Field Valuespublic static final String CORE_JAVA_BUILD_ORDER
getDefaultOptions()
,
Constant Field Valuespublic static final String CORE_JAVA_BUILD_RESOURCE_COPY_FILTER
getDefaultOptions()
,
Constant Field Valuespublic static final String CORE_JAVA_BUILD_DUPLICATE_RESOURCE
getDefaultOptions()
,
Constant Field Valuespublic static final String CORE_JAVA_BUILD_CLEAN_OUTPUT_FOLDER
getDefaultOptions()
,
Constant Field Valuespublic static final String CORE_INCOMPLETE_CLASSPATH
getDefaultOptions()
,
Constant Field Valuespublic static final String CORE_CIRCULAR_CLASSPATH
getDefaultOptions()
,
Constant Field Valuespublic static final String CORE_INCOMPATIBLE_JDK_LEVEL
getDefaultOptions()
,
Constant Field Valuespublic static final String CORE_JAVA_BUILD_INVALID_CLASSPATH
getDefaultOptions()
,
Constant Field Valuespublic static final String CORE_ENCODING
getDefaultOptions()
,
Constant Field Valuespublic static final String CORE_ENABLE_CLASSPATH_EXCLUSION_PATTERNS
getDefaultOptions()
,
Constant Field Valuespublic static final String CORE_ENABLE_CLASSPATH_MULTIPLE_OUTPUT_LOCATIONS
getDefaultOptions()
,
Constant Field Valuespublic static final String DEFAULT_TASK_TAG
public static final String DEFAULT_TASK_PRIORITY
public static final String DEFAULT_TASK_TAGS
public static final String DEFAULT_TASK_PRIORITIES
public static final String FORMATTER_NEWLINE_OPENING_BRACE
DefaultCodeFormatterConstants.FORMATTER_BRACE_POSITION_FOR_ANONYMOUS_TYPE_DECLARATION
,
DefaultCodeFormatterConstants.FORMATTER_BRACE_POSITION_FOR_BLOCK
,
DefaultCodeFormatterConstants.FORMATTER_BRACE_POSITION_FOR_CONSTRUCTOR_DECLARATION
,
DefaultCodeFormatterConstants.FORMATTER_BRACE_POSITION_FOR_METHOD_DECLARATION
,
DefaultCodeFormatterConstants.FORMATTER_BRACE_POSITION_FOR_SWITCH
,
DefaultCodeFormatterConstants.FORMATTER_BRACE_POSITION_FOR_TYPE_DECLARATION
instead
getDefaultOptions()
,
Constant Field Valuespublic static final String FORMATTER_NEWLINE_CONTROL
DefaultCodeFormatterConstants.FORMATTER_INSERT_NEW_LINE_BEFORE_CATCH_IN_TRY_STATEMENT
,
DefaultCodeFormatterConstants.FORMATTER_INSERT_NEW_LINE_BEFORE_ELSE_IN_IF_STATEMENT
,
DefaultCodeFormatterConstants.FORMATTER_INSERT_NEW_LINE_BEFORE_FINALLY_IN_TRY_STATEMENT
,
DefaultCodeFormatterConstants.FORMATTER_INSERT_NEW_LINE_BEFORE_WHILE_IN_DO_STATEMENT
instead.
getDefaultOptions()
,
Constant Field Valuespublic static final String FORMATTER_NEWLINE_ELSE_IF
DefaultCodeFormatterConstants.FORMATTER_COMPACT_ELSE_IF
instead
getDefaultOptions()
,
Constant Field Valuespublic static final String FORMATTER_NEWLINE_EMPTY_BLOCK
DefaultCodeFormatterConstants.FORMATTER_INSERT_NEW_LINE_IN_EMPTY_BLOCK
instead
getDefaultOptions()
,
Constant Field Valuespublic static final String FORMATTER_CLEAR_BLANK_LINES
DefaultCodeFormatterConstants.FORMATTER_NUMBER_OF_EMPTY_LINES_TO_PRESERVE
instead
getDefaultOptions()
,
Constant Field Valuespublic static final String FORMATTER_LINE_SPLIT
DefaultCodeFormatterConstants.FORMATTER_LINE_SPLIT
instead
getDefaultOptions()
,
Constant Field Valuespublic static final String FORMATTER_COMPACT_ASSIGNMENT
DefaultCodeFormatterConstants.FORMATTER_INSERT_SPACE_BEFORE_ASSIGNMENT_OPERATOR
instead
getDefaultOptions()
,
Constant Field Valuespublic static final String FORMATTER_TAB_CHAR
DefaultCodeFormatterConstants.FORMATTER_TAB_CHAR
} instead
getDefaultOptions()
,
Constant Field Valuespublic static final String FORMATTER_TAB_SIZE
DefaultCodeFormatterConstants.FORMATTER_TAB_SIZE
instead
getDefaultOptions()
,
Constant Field Valuespublic static final String FORMATTER_SPACE_CASTEXPRESSION
DefaultCodeFormatterConstants.FORMATTER_INSERT_SPACE_AFTER_CLOSING_PAREN_IN_CAST
instead
getDefaultOptions()
,
Constant Field Valuespublic static final String CODEASSIST_VISIBILITY_CHECK
getDefaultOptions()
,
Constant Field Valuespublic static final String CODEASSIST_IMPLICIT_QUALIFICATION
getDefaultOptions()
,
Constant Field Valuespublic static final String CODEASSIST_FIELD_PREFIXES
getDefaultOptions()
,
Constant Field Valuespublic static final String CODEASSIST_STATIC_FIELD_PREFIXES
getDefaultOptions()
,
Constant Field Valuespublic static final String CODEASSIST_LOCAL_PREFIXES
getDefaultOptions()
,
Constant Field Valuespublic static final String CODEASSIST_ARGUMENT_PREFIXES
getDefaultOptions()
,
Constant Field Valuespublic static final String CODEASSIST_FIELD_SUFFIXES
getDefaultOptions()
,
Constant Field Valuespublic static final String CODEASSIST_STATIC_FIELD_SUFFIXES
getDefaultOptions()
,
Constant Field Valuespublic static final String CODEASSIST_LOCAL_SUFFIXES
getDefaultOptions()
,
Constant Field Valuespublic static final String CODEASSIST_ARGUMENT_SUFFIXES
getDefaultOptions()
,
Constant Field Valuespublic static final String CODEASSIST_FORBIDDEN_REFERENCE_CHECK
getDefaultOptions()
,
Constant Field Valuespublic static final String CODEASSIST_DISCOURAGED_REFERENCE_CHECK
getDefaultOptions()
,
Constant Field Valuespublic static final String GENERATE
getDefaultOptions()
,
Constant Field Valuespublic static final String DO_NOT_GENERATE
getDefaultOptions()
,
Constant Field Valuespublic static final String PRESERVE
getDefaultOptions()
,
Constant Field Valuespublic static final String OPTIMIZE_OUT
getDefaultOptions()
,
Constant Field Valuespublic static final String VERSION_1_1
getDefaultOptions()
,
Constant Field Valuespublic static final String VERSION_1_2
getDefaultOptions()
,
Constant Field Valuespublic static final String VERSION_1_3
getDefaultOptions()
,
Constant Field Valuespublic static final String VERSION_1_4
getDefaultOptions()
,
Constant Field Valuespublic static final String VERSION_1_5
getDefaultOptions()
,
Constant Field Valuespublic static final String ABORT
getDefaultOptions()
,
Constant Field Valuespublic static final String ERROR
getDefaultOptions()
,
Constant Field Valuespublic static final String WARNING
getDefaultOptions()
,
Constant Field Valuespublic static final String IGNORE
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPUTE
getDefaultOptions()
,
Constant Field Valuespublic static final String INSERT
getDefaultOptions()
,
Constant Field Valuespublic static final String DO_NOT_INSERT
getDefaultOptions()
,
Constant Field Valuespublic static final String PRESERVE_ONE
getDefaultOptions()
,
Constant Field Valuespublic static final String CLEAR_ALL
getDefaultOptions()
,
Constant Field Valuespublic static final String NORMAL
getDefaultOptions()
,
Constant Field Valuespublic static final String COMPACT
getDefaultOptions()
,
Constant Field Valuespublic static final String TAB
getDefaultOptions()
,
Constant Field Valuespublic static final String SPACE
getDefaultOptions()
,
Constant Field Valuespublic static final String ENABLED
getDefaultOptions()
,
Constant Field Valuespublic static final String DISABLED
getDefaultOptions()
,
Constant Field Valuespublic static final String CLEAN
getDefaultOptions()
,
Constant Field Valuespublic static final String PUBLIC
getDefaultOptions()
,
Constant Field Valuespublic static final String PROTECTED
getDefaultOptions()
,
Constant Field Valuespublic static final String DEFAULT
getDefaultOptions()
,
Constant Field Valuespublic static final String PRIVATE
getDefaultOptions()
,
Constant Field Valuespublic static final String NEVER
getDefaultOptions()
,
Constant Field ValuesConstructor Detail |
public JavaCore()
The plug-in instance is created automatically by the Eclipse platform. Clients must not call.
Method Detail |
public static void addElementChangedListener(IElementChangedListener listener)
addElementChangedListener(IElementChangedListener,int)
,
which allows to specify a different eventMask.
listener
- the listenerElementChangedEvent
public static void addElementChangedListener(IElementChangedListener listener, int eventMask)
Once registered, a listener starts receiving notification of changes to java elements in the model. The listener continues to receive notifications until it is replaced or removed.
Listeners can listen for several types of event as defined in ElementChangeEvent
.
Clients are free to register for any number of event types however if they register
for more than one, it is their responsibility to ensure they correctly handle the
case where the same java element change shows up in multiple notifications.
Clients are guaranteed to receive only the events for which they are registered.
listener
- the listenereventMask
- the bit-wise OR of all event types of interest to the listenerIElementChangedListener
,
ElementChangedEvent
,
removeElementChangedListener(IElementChangedListener)
public static void addJavaElementMarkerAttributes(Map attributes, IJavaElement element)
attributes
- the mutable marker attribute map (key type: String
,
value type: String
)element
- the Java element for which the marker needs to be configuredpublic static void addPreProcessingResourceChangedListener(IResourceChangeListener listener)
Has no effect if an identical listener is already registered.
listener
- the listenerremovePreProcessingResourceChangedListener(IResourceChangeListener)
public void configureJavaElementMarker(IMarker marker, IJavaElement element) throws CoreException
marker
- the marker to be configuredelement
- the Java element for which the marker needs to be configured
CoreException
- if the IMarker.setAttribute
on the marker failspublic static IJavaElement create(String handleIdentifier)
IJavaElement.getHandleIdentifier()
, or
null
if unable to create the associated element.
handleIdentifier
- the given handle identifier
public static IJavaElement create(String handleIdentifier, WorkingCopyOwner owner)
IJavaElement.getHandleIdentifier()
, or
null
if unable to create the associated element.
If the returned Java element is an ICompilationUnit
, its owner
is the given owner if such a working copy exists, otherwise the compilation unit
is a primary compilation unit.
handleIdentifier
- the given handle identifierowner
- the owner of the returned compilation unit, ignored if the returned
element is not a compilation unit
public static IJavaElement create(IFile file)
null
if unable to associate the given file
with a Java element.
The file must be one of:
.java
file - the element returned is the corresponding ICompilationUnit
.class
file - the element returned is the corresponding IClassFile
.jar
file - the element returned is the corresponding IPackageFragmentRoot
Creating a Java element has the side effect of creating and opening all of the element's parents if they are not yet open.
file
- the given file
null
if unable to associate the given file
with a Java elementpublic static IJavaElement create(IFolder folder)
null
if unable to associate the given folder with a Java element.
Note that a package fragment root is returned rather than a default package.
Creating a Java element has the side effect of creating and opening all of the element's parents if they are not yet open.
folder
- the given folder
null
if unable to associate the given folder with a Java elementpublic static IJavaProject create(IProject project)
Creating a Java Project has the side effect of creating and opening all of the project's parents if they are not yet open.
Note that no check is done at this time on the existence or the java nature of this project.
project
- the given project
public static IJavaElement create(IResource resource)
null
if unable to associate the given resource
with a Java element.
The resource must be one of:
IJavaProject
.java
file - the element returned is the corresponding ICompilationUnit
.class
file - the element returned is the corresponding IClassFile
.jar
file - the element returned is the corresponding IPackageFragmentRoot
IPackageFragmentRoot
or IPackageFragment
IJavaModel
Creating a Java element has the side effect of creating and opening all of the element's parents if they are not yet open.
resource
- the given resource
null
if unable to associate the given resource
with a Java elementpublic static IJavaModel create(IWorkspaceRoot root)
root
- the given root
null
if the root is nullpublic static IClassFile createClassFileFrom(IFile file)
.class
file. Returns null
if unable
to recognize the class file.
file
- the given .class
file
.class
file, or null
if unable
to recognize the class filepublic static ICompilationUnit createCompilationUnitFrom(IFile file)
.java
file. Returns null
if unable
to recognize the compilation unit.
file
- the given .java
file
.java
file, or null
if unable
to recognize the compilation unitpublic static IPackageFragmentRoot createJarPackageFragmentRootFrom(IFile file)
file
- the given JAR file
null
if unable to create a JAR package fragment root.
(for example, if the JAR file represents a non-Java resource)public static IClasspathContainer getClasspathContainer(IPath containerPath, IJavaProject project) throws JavaModelException
null
.
Both the container path and the project context are supposed to be non-null.
The containerPath is a formed by a first ID segment followed with extra segments, which can be
used as additional hints for resolution. If no container was ever recorded for this container path
onto this project (using setClasspathContainer
, then a
ClasspathContainerInitializer
will be activated if any was registered for this container
ID onto the extension point "org.eclipse.jdt.core.classpathContainerInitializer".
There is no assumption that the returned container must answer the exact same containerPath
when requested IClasspathContainer#getPath
.
Indeed, the containerPath is just an indication for resolving it to an actual container object.
Classpath container values are persisted locally to the workspace, but
are not preserved from a session to another. It is thus highly recommended to register a
ClasspathContainerInitializer
for each referenced container
(through the extension point "org.eclipse.jdt.core.ClasspathContainerInitializer").
containerPath
- the name of the container, which needs to be resolvedproject
- a specific project in which the container is being resolved
null
if unable to find one.
JavaModelException
- if an exception occurred while resolving the container, or if the resolved container
contains illegal entries (contains CPE_CONTAINER entries or null entries).ClasspathContainerInitializer
,
IClasspathContainer
,
setClasspathContainer(IPath, IJavaProject[], IClasspathContainer[], IProgressMonitor)
public static ClasspathContainerInitializer getClasspathContainerInitializer(String containerID)
null
if none was found while iterating over the contributions to extension point to
the extension point "org.eclipse.jdt.core.classpathContainerInitializer".
A containerID is the first segment of any container path, used to identify the registered container initializer.
containerID
- - a containerID identifying a registered initializer
null
if
none was found.public static IPath getClasspathVariable(String variableName)
Classpath variable values are persisted locally to the workspace, and are preserved from session to session.
Note that classpath variables can be contributed registered initializers for, using the extension point "org.eclipse.jdt.core.classpathVariableInitializer". If an initializer is registered for a variable, its persisted value will be ignored: its initializer will thus get the opportunity to rebind the variable differently on each session.
variableName
- the name of the classpath variable
null
if nonesetClasspathVariable(String, IPath)
public static ClasspathVariableInitializer getClasspathVariableInitializer(String variable)
null
if none was found while iterating over the contributions to extension point to
the extension point "org.eclipse.jdt.core.classpathVariableInitializer".
variable
- the given variable
null
if
none was found.public static String[] getClasspathVariableNames()
Classpath variable values are persisted locally to the workspace, and are preserved from session to session.
setClasspathVariable(String, IPath)
public static Hashtable getDefaultOptions()
setOptions
.
Helper constants have been defined on JavaCore for each of the option ID and
their possible constant values.
Note: more options might be added in further releases.
RECOGNIZED OPTIONS: COMPILER / Setting Compliance Level Select the compliance level for the compiler. In "1.3" mode, source and target settings should not go beyond "1.3" level. - option id: "org.eclipse.jdt.core.compiler.compliance" - possible values: { "1.3", "1.4", "1.5" } - default: "1.4" COMPILER / Setting Source Compatibility Mode Specify whether which source level compatibility is used. From 1.4 on, 'assert' is a keyword reserved for assertion support. Also note, than when toggling to 1.4 mode, the target VM level should be set to "1.4" and the compliance mode should be "1.4". Source level 1.5 is necessary to enable generics, autoboxing, covariance, annotations, enumerations enhanced for loop, static imports and varargs. Once toggled, the target VM level should be set to "1.5" and the compliance mode should be "1.5". - option id: "org.eclipse.jdt.core.compiler.source" - possible values: { "1.3", "1.4", "1.5" } - default: "1.3" COMPILER / Defining Target Java Platform For binary compatibility reason, .class files can be tagged to with certain VM versions and later. Note that "1.4" target require to toggle compliance mode to "1.4" too. Similarily, "1.5" target require to toggle compliance mode to "1.5". - option id: "org.eclipse.jdt.core.compiler.codegen.targetPlatform" - possible values: { "1.1", "1.2", "1.3", "1.4", "1.5" } - default: "1.2" COMPILER / Generating Local Variable Debug Attribute When generated, this attribute will enable local variable names to be displayed in debugger, only in place where variables are definitely assigned (.class file is then bigger) - option id: "org.eclipse.jdt.core.compiler.debug.localVariable" - possible values: { "generate", "do not generate" } - default: "generate" COMPILER / Generating Line Number Debug Attribute When generated, this attribute will enable source code highlighting in debugger (.class file is then bigger). - option id: "org.eclipse.jdt.core.compiler.debug.lineNumber" - possible values: { "generate", "do not generate" } - default: "generate" COMPILER / Generating Source Debug Attribute When generated, this attribute will enable the debugger to present the corresponding source code. - option id: "org.eclipse.jdt.core.compiler.debug.sourceFile" - possible values: { "generate", "do not generate" } - default: "generate" COMPILER / Preserving Unused Local Variables Unless requested to preserve unused local variables (that is, never read), the compiler will optimize them out, potentially altering debugging - option id: "org.eclipse.jdt.core.compiler.codegen.unusedLocal" - possible values: { "preserve", "optimize out" } - default: "preserve" COMPILER / Inline JSR Bytecode Instruction When enabled, the compiler will no longer generate JSR instructions, but rather inline corresponding subroutine code sequences (mostly corresponding to try finally blocks). The generated code will thus get bigger, but will load faster on virtual machines since the verification process is then much simpler. This mode is anticipating support for the Java Specification Request 202. Note that JSR inlining is optional only for target platform lesser than 1.5. From 1.5 on, the JSR inlining is mandatory (also see related setting "org.eclipse.jdt.core.compiler.codegen.targetPlatform"). - option id: "org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode" - possible values: { "enabled", "disabled" } - default: "disabled" COMPILER / Javadoc Comment Support When this support is disabled, the compiler will ignore all javadoc problems options settings and will not report any javadoc problem. It will also not find any reference in javadoc comment and DOM AST Javadoc node will be only a flat text instead of having structured tag elements. - option id: "org.eclipse.jdt.core.compiler.doc.comment.support" - possible values: { "enabled", "disabled" } - default: "enabled" COMPILER / Reporting Attempt to Override Package-Default Method A package default method is not visible in a different package, and thus cannot be overridden. When enabling this option, the compiler will signal such scenarii either as an error or a warning. - option id: "org.eclipse.jdt.core.compiler.problem.overridingPackageDefaultMethod" - possible values: { "error", "warning", "ignore" } - default: "warning" COMPILER / Reporting Method With Constructor Name Naming a method with a constructor name is generally considered poor style programming. When enabling this option, the compiler will signal such scenarii either as an error or a warning. - option id: "org.eclipse.jdt.core.compiler.problem.methodWithConstructorName" - possible values: { "error", "warning", "ignore" } - default: "warning" COMPILER / Reporting Deprecation When enabled, the compiler will signal use of deprecated API either as an error or a warning. - option id: "org.eclipse.jdt.core.compiler.problem.deprecation" - possible values: { "error", "warning", "ignore" } - default: "warning" COMPILER / Reporting Deprecation Inside Deprecated Code When enabled, the compiler will signal use of deprecated API inside deprecated code. The severity of the problem is controlled with option "org.eclipse.jdt.core.compiler.problem.deprecation". - option id: "org.eclipse.jdt.core.compiler.problem.deprecationInDeprecatedCode" - possible values: { "enabled", "disabled" } - default: "disabled" COMPILER / Reporting Deprecation When Overriding Deprecated Method When enabled, the compiler will signal the declaration of a method overriding a deprecated one. The severity of the problem is controlled with option "org.eclipse.jdt.core.compiler.problem.deprecation". - option id: "org.eclipse.jdt.core.compiler.problem.deprecationWhenOverridingDeprecatedMethod" - possible values: { "enabled", "disabled" } - default: "disabled" COMPILER / Reporting Hidden Catch Block Locally to a try statement, some catch blocks may hide others . For example, try { throw new java.io.CharConversionException(); } catch (java.io.CharConversionException e) { } catch (java.io.IOException e) {}. When enabling this option, the compiler will issue an error or a warning for hidden catch blocks corresponding to checked exceptions - option id: "org.eclipse.jdt.core.compiler.problem.hiddenCatchBlock" - possible values: { "error", "warning", "ignore" } - default: "warning" COMPILER / Reporting Unused Local When enabled, the compiler will issue an error or a warning for unused local variables (that is, variables never read from) - option id: "org.eclipse.jdt.core.compiler.problem.unusedLocal" - possible values: { "error", "warning", "ignore" } - default: "ignore" COMPILER / Reporting Unused Parameter When enabled, the compiler will issue an error or a warning for unused method parameters (that is, parameters never read from) - option id: "org.eclipse.jdt.core.compiler.problem.unusedParameter" - possible values: { "error", "warning", "ignore" } - default: "ignore" COMPILER / Reporting Unused Parameter if Implementing Abstract Method When enabled, the compiler will signal unused parameters in abstract method implementations. The severity of the problem is controlled with option "org.eclipse.jdt.core.compiler.problem.unusedParameter". - option id: "org.eclipse.jdt.core.compiler.problem.unusedParameterWhenImplementingAbstract" - possible values: { "enabled", "disabled" } - default: "disabled" COMPILER / Reporting Unused Parameter if Overriding Concrete Method When enabled, the compiler will signal unused parameters in methods overriding concrete ones. The severity of the problem is controlled with option "org.eclipse.jdt.core.compiler.problem.unusedParameter". - option id: "org.eclipse.jdt.core.compiler.problem.unusedParameterWhenOverridingConcrete" - possible values: { "enabled", "disabled" } - default: "disabled" COMPILER / Reporting Unused Import When enabled, the compiler will issue an error or a warning for unused import reference - option id: "org.eclipse.jdt.core.compiler.problem.unusedImport" - possible values: { "error", "warning", "ignore" } - default: "warning" COMPILER / Reporting Unused Private Members When enabled, the compiler will issue an error or a warning whenever a private method or field is declared but never used within the same unit. - option id: "org.eclipse.jdt.core.compiler.problem.unusedPrivateMember" - possible values: { "error", "warning", "ignore" } - default: "ignore" COMPILER / Reporting Assignment with no Effect When enabled, the compiler will issue an error or a warning whenever an assignment has no effect (e.g 'x = x'). - option id: "org.eclipse.jdt.core.compiler.problem.noEffectAssignment" - possible values: { "error", "warning", "ignore" } - default: "warning" COMPILER / Reporting Empty Statements and Unnecessary Semicolons When enabled, the compiler will issue an error or a warning if an empty statement or a unnecessary semicolon is encountered. - option id: "org.eclipse.jdt.core.compiler.problem.emptyStatement" - possible values: { "error", "warning", "ignore" } - default: "ignore" COMPILER / Reporting Unnecessary Type Check When enabled, the compiler will issue an error or a warning when a cast or an instanceof operation is unnecessary. - option id: "org.eclipse.jdt.core.compiler.problem.unnecessaryTypeCheck" - possible values: { "error", "warning", "ignore" } - default: "ignore" COMPILER / Reporting Unnecessary Else When enabled, the compiler will issue an error or a warning when a statement is unnecessarily nested within an else clause (in situation where then clause is not completing normally). - option id: "org.eclipse.jdt.core.compiler.problem.unnecessaryElse" - possible values: { "error", "warning", "ignore" } - default: "ignore" COMPILER / Reporting Synthetic Access Emulation When enabled, the compiler will issue an error or a warning whenever it emulates access to a non-accessible member of an enclosing type. Such access can have performance implications. - option id: "org.eclipse.jdt.core.compiler.problem.syntheticAccessEmulation" - possible values: { "error", "warning", "ignore" } - default: "ignore" COMPILER / Reporting Non-Externalized String Literal When enabled, the compiler will issue an error or a warning for non externalized String literal (that is, not tagged with //$NON-NLS-<n>$). - option id: "org.eclipse.jdt.core.compiler.problem.nonExternalizedStringLiteral" - possible values: { "error", "warning", "ignore" } - default: "ignore" COMPILER / Reporting Usage of 'assert' Identifier When enabled, the compiler will issue an error or a warning whenever 'assert' is used as an identifier (reserved keyword in 1.4) - option id: "org.eclipse.jdt.core.compiler.problem.assertIdentifier" - possible values: { "error", "warning", "ignore" } - default: "warning" COMPILER / Reporting Usage of 'enum' Identifier When enabled, the compiler will issue an error or a warning whenever 'enum' is used as an identifier (reserved keyword in 1.5) - option id: "org.eclipse.jdt.core.compiler.problem.enumIdentifier" - possible values: { "error", "warning", "ignore" } - default: "warning" COMPILER / Reporting Non-Static Reference to a Static Member When enabled, the compiler will issue an error or a warning whenever a static field or method is accessed with an expression receiver. A reference to a static member should be qualified with a type name. - option id: "org.eclipse.jdt.core.compiler.problem.staticAccessReceiver" - possible values: { "error", "warning", "ignore" } - default: "warning" COMPILER / Reporting Indirect Reference to a Static Member When enabled, the compiler will issue an error or a warning whenever a static field or method is accessed in an indirect way. A reference to a static member should preferably be qualified with its declaring type name. - option id: "org.eclipse.jdt.core.compiler.problem.indirectStaticAccess" - possible values: { "error", "warning", "ignore" } - default: "ignore" COMPILER / Reporting Interface Method not Compatible with non-Inherited Methods When enabled, the compiler will issue an error or a warning whenever an interface defines a method incompatible with a non-inherited Object method. Until this conflict is resolved, such an interface cannot be implemented, For example, interface I { int clone(); } - option id: "org.eclipse.jdt.core.compiler.problem.incompatibleNonInheritedInterfaceMethod" - possible values: { "error", "warning", "ignore" } - default: "warning" COMPILER / Reporting Usage of char[] Expressions in String Concatenations When enabled, the compiler will issue an error or a warning whenever a char[] expression is used in String concatenations (for example, "hello" + new char[]{'w','o','r','l','d'}). - option id: "org.eclipse.jdt.core.compiler.problem.noImplicitStringConversion" - possible values: { "error", "warning", "ignore" } - default: "warning" COMPILER / Reporting Local Variable Declaration Hiding another Variable When enabled, the compiler will issue an error or a warning whenever a local variable declaration is hiding some field or local variable (either locally, inherited or defined in enclosing type). - option id: "org.eclipse.jdt.core.compiler.problem.localVariableHiding" - possible values: { "error", "warning", "ignore" } - default: "ignore" COMPILER / Reporting Field Declaration Hiding another Variable When enabled, the compiler will issue an error or a warning whenever a field declaration is hiding some field or local variable (either locally, inherited or defined in enclosing type). - option id: "org.eclipse.jdt.core.compiler.problem.fieldHiding" - possible values: { "error", "warning", "ignore" } - default: "ignore" COMPILER / Reporting Special Parameter Hiding another Field When enabled, the compiler will signal cases where a constructor or setter method parameter declaration is hiding some field (either locally, inherited or defined in enclosing type). The severity of the problem is controlled with option "org.eclipse.jdt.core.compiler.problem.localVariableHiding". - option id: "org.eclipse.jdt.core.compiler.problem.specialParameterHidingField" - possible values: { "enabled", "disabled" } - default: "disabled" COMPILER / Reporting Type Parameter Declaration Hiding another Type When enabled, the compiler will issue an error or a warning whenever a type parameter declaration is hiding some type. - option id: "org.eclipse.jdt.core.compiler.problem.typeParameterHiding" - possible values: { "error", "warning", "ignore" } - default: "warning" COMPILER / Reporting Possible Accidental Boolean Assignment When enabled, the compiler will issue an error or a warning if a boolean assignment is acting as the condition of a control statement (where it probably was meant to be a boolean comparison). - option id: "org.eclipse.jdt.core.compiler.problem.possibleAccidentalBooleanAssignment" - possible values: { "error", "warning", "ignore" } - default: "ignore" COMPILER / Reporting Undocumented Empty Block When enabled, the compiler will issue an error or a warning when an empty block is detected and it is not documented with any comment. - option id: "org.eclipse.jdt.core.compiler.problem.undocumentedEmptyBlock" - possible values: { "error", "warning", "ignore" } - default: "ignore" COMPILER / Reporting Finally Blocks Not Completing Normally When enabled, the compiler will issue an error or a warning when a finally block does not complete normally. - option id: "org.eclipse.jdt.core.compiler.problem.finallyBlockNotCompletingNormally" - possible values: { "error", "warning", "ignore" } - default: "warning" COMPILER / Reporting Unused Declared Thrown Exception When enabled, the compiler will issue an error or a warning when a method or a constructor is declaring a thrown checked exception, but never actually raises it in its body. - option id: "org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownException" - possible values: { "error", "warning", "ignore" } - default: "ignore" COMPILER / Reporting Unused Declared Thrown Exception in Overridind Method When disabled, the compiler will not include overriding methods in its diagnosis for unused declared thrown exceptions.
The severity of the problem is controlled with option "org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownException". - option id: "org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownExceptionWhenOverriding" - possible values: { "enabled", "disabled" } - default: "disabled" COMPILER / Reporting Unqualified Access to Field When enabled, the compiler will issue an error or a warning when a field is access without any qualification. In order to improve code readability, it should be qualified, e.g. 'x' should rather be written 'this.x'. - option id: "org.eclipse.jdt.core.compiler.problem.unqualifiedFieldAccess" - possible values: { "error", "warning", "ignore" } - default: "ignore" COMPILER / Reporting Unchecked Type Operation When enabled, the compiler will issue an error or a warning whenever an operation involves generic types, and potentially invalidates type safety since involving raw types (e.g. invoking #foo(X<String>) with arguments (X)). - option id: "org.eclipse.jdt.core.compiler.problem.uncheckedTypeOperation" - possible values: { "error", "warning", "ignore" } - default: "warning" COMPILER / Reporting final Bound for Type Parameter When enabled, the compiler will issue an error or a warning whenever a generic type parameter is associated with a bound corresponding to a final type; since final types cannot be further extended, the parameter is pretty useless. - option id: "org.eclipse.jdt.core.compiler.problem.finalParameterBound" - possible values: { "error", "warning", "ignore" } - default: "warning" COMPILER / Reporting Missing Declaration of serialVersionUID Field on Serializable Class When enabled, the compiler will issue an error or a warning whenever a serializable class is missing a local declaration of a serialVersionUID field. This field must be declared as static final and be of type long. - option id: "org.eclipse.jdt.core.compiler.problem.missingSerialVersion" - possible values: { "error", "warning", "ignore" } - default: "warning" COMPILER / Reporting Varargs Argument Needing a Cast in Method/Constructor Invocation When enabled, the compiler will issue an error or a warning whenever a varargs arguments should be cast when passed to a method/constructor invocation. (e.g. Class.getMethod(String name, Class ... args ) invoked with arguments ("foo", null)). - option id: "org.eclipse.jdt.core.compiler.problem.varargsArgumentNeedCast" - possible values: { "error", "warning", "ignore" } - default: "warning" COMPILER / Reporting Null Reference or Dereference When enabled, the compiler will issue an error or a warning whenever assumption were made on a variable with respect to holding null/non-null values, but the assumption is not followed in a consistent manner. Situations include: - if variable was assumed to be null and further used to access field or methods - if variable was assumed to be null or non-null and further tested for null cases. - option id: "org.eclipse.jdt.core.compiler.problem.nullReference" - possible values: { "error", "warning", "ignore" } - default: "warning" COMPILER / Reporting Use of Annotation Type as Super Interface When enabled, the compiler will issue an error or a warning whenever an annotation type is used as a super-interface. Though legal, this is discouraged. - option id: "org.eclipse.jdt.core.compiler.problem.annotationSuperInterface" - possible values: { "error", "warning", "ignore" } - default: "warning" COMPILER / Reporting Missing @Override Annotation When enabled, the compiler will issue an error or a warning whenever encountering a method declaration which overrides a superclass method but has no @Override annotation. - option id: "org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotation" - possible values: { "error", "warning", "ignore" } - default: "ignore" COMPILER / Reporting Missing @Deprecated Annotation When enabled, the compiler will issue an error or a warning whenever encountering a declaration carrying a @deprecated doc tag but has no corresponding @Deprecated annotation. - option id: "org.eclipse.jdt.core.compiler.problem.missingDeprecatedAnnotation" - possible values: { "error", "warning", "ignore" } - default: "ignore" COMPILER / Reporting Incomplete Enum Switch When enabled, the compiler will issue an error or a warning whenever an enum constant has no corresponding case label in an enum switch statement type has no case label matching an enum constant. - option id: "org.eclipse.jdt.core.compiler.problem.incompleteEnumSwitch" - possible values: { "error", "warning", "ignore" } - default: "ignore" COMPILER / Reporting Boxing/Unboxing Conversion When enabled, the compiler will issue an error or a warning whenever a boxing or an unboxing conversion is performed. - option id: "org.eclipse.jdt.core.compiler.problem.autoboxing" - possible values: { "error", "warning", "ignore" } - default: "ignore" COMPILER / Reporting Invalid Javadoc Comment This is the generic control for the severity of Javadoc problems. When enabled, the compiler will issue an error or a warning for a problem in Javadoc. - option id: "org.eclipse.jdt.core.compiler.problem.invalidJavadoc" - possible values: { "error", "warning", "ignore" } - default: "ignore" COMPILER / Visibility Level For Invalid Javadoc Tags Set the minimum visibility level for Javadoc tag problems. Below this level problems will be ignored. - option id: "org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsVisibility" - possible values: { "public", "protected", "default", "private" } - default: "private" COMPILER / Reporting Invalid Javadoc Tags When enabled, the compiler will signal unbound or unexpected reference tags in Javadoc. A 'throws' tag referencing an undeclared exception would be considered as unexpected.
Note that this diagnosis can be enabled based on the visibility of the construct associated with the Javadoc; also see the setting "org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsVisibility".
The severity of the problem is controlled with option "org.eclipse.jdt.core.compiler.problem.invalidJavadoc". - option id: "org.eclipse.jdt.core.compiler.problem.invalidJavadocTags" - possible values: { "disabled", "enabled" } - default: "enabled" COMPILER / Reporting Invalid Javadoc Tags with Deprecated References Specify whether the compiler will report deprecated references used in Javadoc tags.
Note that this diagnosis can be enabled based on the visibility of the construct associated with the Javadoc; also see the setting "org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsVisibility". - option id: "org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsDeprecatedRef" - possible values: { "enabled", "disabled" } - default: "enabled" COMPILER / Reporting Invalid Javadoc Tags with Not Visible References Specify whether the compiler will report non-visible references used in Javadoc tags.
Note that this diagnosis can be enabled based on the visibility of the construct associated with the Javadoc; also see the setting "org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsVisibility". - option id: "org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsNotVisibleRef" - possible values: { "enabled", "disabled" } - default: "enabled" COMPILER / Reporting Missing Javadoc Tags This is the generic control for the severity of Javadoc missing tag problems. When enabled, the compiler will issue an error or a warning when tags are missing in Javadoc comments.
Note that this diagnosis can be enabled based on the visibility of the construct associated with the Javadoc; also see the setting "org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility".
- option id: "org.eclipse.jdt.core.compiler.problem.missingJavadocTags" - possible values: { "error", "warning", "ignore" } - default: "ignore" COMPILER / Visibility Level For Missing Javadoc Tags Set the minimum visibility level for Javadoc missing tag problems. Below this level problems will be ignored. - option id: "org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility" - possible values: { "public", "protected", "default", "private" } - default: "private" COMPILER / Reporting Missing Javadoc Tags on Overriding Methods Specify whether the compiler will verify overriding methods in order to report Javadoc missing tag problems. - option id: "org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding" - possible values: { "enabled", "disabled" } - default: "disabled" COMPILER / Reporting Missing Javadoc Comments This is the generic control for the severity of missing Javadoc comment problems. When enabled, the compiler will issue an error or a warning when Javadoc comments are missing.
Note that this diagnosis can be enabled based on the visibility of the construct associated with the expected Javadoc; also see the setting "org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility".
- option id: "org.eclipse.jdt.core.compiler.problem.missingJavadocComments" - possible values: { "error", "warning", "ignore" } - default: "ignore" COMPILER / Visibility Level For Missing Javadoc Comments Set the minimum visibility level for missing Javadoc problems. Below this level problems will be ignored. - option id: "org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility" - possible values: { "public", "protected", "default", "private" } - default: "public" COMPILER / Reporting Missing Javadoc Comments on Overriding Methods Specify whether the compiler will verify overriding methods in order to report missing Javadoc comment problems. - option id: "org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding" - possible values: { "enabled", "disabled" } - default: "disabled" COMPILER / Maximum number of problems reported per compilation unit Specify the maximum number of problems reported on each compilation unit. - option id: "org.eclipse.jdt.core.compiler.maxProblemPerUnit" - possible values: "<n>" where <n> is zero or a positive integer (if zero then all problems are reported). - default: "100" COMPILER / Defining the Automatic Task Tags When the tag list is not empty, the compiler will issue a task marker whenever it encounters one of the corresponding tag inside any comment in Java source code. Generated task messages will include the tag, and range until the next line separator or comment ending. Note that tasks messages are trimmed. If a tag is starting with a letter or digit, then it cannot be leaded by another letter or digit to be recognized ("fooToDo" will not be recognized as a task for tag "ToDo", but "foo#ToDo" will be detected for either tag "ToDo" or "#ToDo"). Respectively, a tag ending with a letter or digit cannot be followed by a letter or digit to be recognized ("ToDofoo" will not be recognized as a task for tag "ToDo", but "ToDo:foo" will be detected either for tag "ToDo" or "ToDo:"). Note: the tasks are ordered, and the first matching tag will be selected; e.g. "TODO,TODO!" will match "TODO!" against "TODO" first. - option id: "org.eclipse.jdt.core.compiler.taskTags" - possible values: { "<tag>[,<tag>]*" } where <tag> is a String without any wild-card or leading/trailing spaces - default: "TODO,FIXME,XXX" COMPILER / Defining the Automatic Task Priorities In parallel with the Automatic Task Tags, this list defines the priorities (high, normal or low) of the task markers issued by the compiler. If the default is specified, the priority of each task marker is "NORMAL". - option id: "org.eclipse.jdt.core.compiler.taskPriorities" - possible values: { "<priority>[,<priority>]*" } where <priority> is one of "HIGH", "NORMAL" or "LOW" - default: "NORMAL,HIGH,NORMAL" COMPILER / Determining whether task tags are case-sensitive When enabled, task tags are considered in a case-sensitive way. - option id: "org.eclipse.jdt.core.compiler.taskCaseSensitive" - possible values: { "enabled", "disabled" } - default: "enabled" COMPILER / Reporting Forbidden Reference to Type with Restricted Access When enabled, the compiler will issue an error or a warning when referring to a type that is non accessible, as defined according to the access rule specifications. - option id: "org.eclipse.jdt.core.compiler.problem.forbiddenReference" - possible values: { "error", "warning", "ignore" } - default: "warning" COMPILER / Reporting Discouraged Reference to Type with Restricted Access When enabled, the compiler will issue an error or a warning when referring to a type with discouraged access, as defined according to the access rule specifications. - option id: "org.eclipse.jdt.core.compiler.problem.discouragedReference" - possible values: { "error", "warning", "ignore" } - default: "warning" COMPILER / Determining Effect of @SuppressWarnings When enabled, the @SuppressWarnings annotation can be used to suppress some compiler warnings. When disabled, all @SupressWarnings annotations are ignored; i.e., warnings are reported. - option id: "org.eclipse.jdt.core.compiler.problem.suppressWarnings" - possible values: { "enabled", "disabled" } - default: "enabled" COMPILER / Reporting Unhandled Warning Token for @SuppressWarnings When enabled, the compiler will issue an error or a warning when encountering a token it cannot handle inside a @SuppressWarnings annotation. - option id: "org.eclipse.jdt.core.compiler.problem.unhandledWarningToken" - possible values: { "error", "warning", "ignore" } - default: "warning" BUILDER / Specifying Filters for Resource Copying Control Allow to specify some filters to control the resource copy process. - option id: "org.eclipse.jdt.core.builder.resourceCopyExclusionFilter" - possible values: { "<name>[,<name>]* } where <name> is a file name pattern (* and ? wild-cards allowed) or the name of a folder which ends with '/' - default: "" BUILDER / Abort if Invalid Classpath Allow to toggle the builder to abort if the classpath is invalid - option id: "org.eclipse.jdt.core.builder.invalidClasspath" - possible values: { "abort", "ignore" } - default: "abort" BUILDER / Cleaning Output Folder(s) Indicate whether the JavaBuilder is allowed to clean the output folders when performing full build operations. - option id: "org.eclipse.jdt.core.builder.cleanOutputFolder" - possible values: { "clean", "ignore" } - default: "clean" BUILDER / Reporting Duplicate Resources Indicate the severity of the problem reported when more than one occurrence of a resource is to be copied into the output location. - option id: "org.eclipse.jdt.core.builder.duplicateResourceTask" - possible values: { "error", "warning" } - default: "warning" JAVACORE / Computing Project Build Order Indicate whether JavaCore should enforce the project build order to be based on the classpath prerequisite chain. When requesting to compute, this takes over the platform default order (based on project references). - option id: "org.eclipse.jdt.core.computeJavaBuildOrder" - possible values: { "compute", "ignore" } - default: "ignore" JAVACORE / Specify Default Source Encoding Format Get the encoding format for compiled sources. This setting is read-only, it is equivalent to 'ResourcesPlugin.getEncoding()'. - option id: "org.eclipse.jdt.core.encoding" - possible values: { any of the supported encoding name}. - default: <platform default> JAVACORE / Reporting Incomplete Classpath Indicate the severity of the problem reported when an entry on the classpath does not exist, is not legite or is not visible (for example, a referenced project is closed). - option id: "org.eclipse.jdt.core.incompleteClasspath" - possible values: { "error", "warning"} - default: "error" JAVACORE / Reporting Classpath Cycle Indicate the severity of the problem reported when a project is involved in a cycle. - option id: "org.eclipse.jdt.core.circularClasspath" - possible values: { "error", "warning" } - default: "error" JAVACORE / Reporting Incompatible JDK Level for Required Binaries Indicate the severity of the problem reported when a project prerequisites another project or library with an incompatible target JDK level (e.g. project targeting 1.1 vm, but compiled against 1.4 libraries). - option id: "org.eclipse.jdt.core.incompatibleJDKLevel" - possible values: { "error", "warning", "ignore" } - default: "ignore" JAVACORE / Enabling Usage of Classpath Exclusion Patterns When disabled, no entry on a project classpath can be associated with an exclusion pattern. - option id: "org.eclipse.jdt.core.classpath.exclusionPatterns" - possible values: { "enabled", "disabled" } - default: "enabled" JAVACORE / Enabling Usage of Classpath Multiple Output Locations When disabled, no entry on a project classpath can be associated with a specific output location, preventing thus usage of multiple output locations. - option id: "org.eclipse.jdt.core.classpath.multipleOutputLocations" - possible values: { "enabled", "disabled" } - default: "enabled" FORMATTER / Inserting New Line Before Opening Brace When Insert, a new line is inserted before an opening brace, otherwise nothing is inserted - option id: "org.eclipse.jdt.core.formatter.newline.openingBrace" - possible values: { "insert", "do not insert" } - default: "do not insert" FORMATTER / Inserting New Line Inside Control Statement When Insert, a new line is inserted between } and following else, catch, finally - option id: "org.eclipse.jdt.core.formatter.newline.controlStatement" - possible values: { "insert", "do not insert" } - default: "do not insert" FORMATTER / Clearing Blank Lines When Clear all, all blank lines are removed. When Preserve one, only one is kept and all others removed. - option id: "org.eclipse.jdt.core.formatter.newline.clearAll" - possible values: { "clear all", "preserve one" } - default: "preserve one" FORMATTER / Inserting New Line Between Else/If When Insert, a blank line is inserted between an else and an if when they are contiguous. When choosing to not insert, else-if will be kept on the same line when possible. - option id: "org.eclipse.jdt.core.formatter.newline.elseIf" - possible values: { "insert", "do not insert" } - default: "do not insert" FORMATTER / Inserting New Line In Empty Block When insert, a line break is inserted between contiguous { and }, if } is not followed by a keyword. - option id: "org.eclipse.jdt.core.formatter.newline.emptyBlock" - possible values: { "insert", "do not insert" } - default: "insert" FORMATTER / Splitting Lines Exceeding Length Enable splitting of long lines (exceeding the configurable length). Length of 0 will disable line splitting - option id: "org.eclipse.jdt.core.formatter.lineSplit" - possible values: "<n>", where n is zero or a positive integer - default: "80" FORMATTER / Compacting Assignment Assignments can be formatted asymmetrically, for example 'int x= 2;', when Normal, a space is inserted before the assignment operator - option id: "org.eclipse.jdt.core.formatter.style.assignment" - possible values: { "compact", "normal" } - default: "normal" FORMATTER / Defining Indentation Character Either choose to indent with tab characters or spaces - option id: "org.eclipse.jdt.core.formatter.tabulation.char" - possible values: { "tab", "space" } - default: "tab" FORMATTER / Defining Space Indentation Length When using spaces, set the amount of space characters to use for each indentation mark. - option id: "org.eclipse.jdt.core.formatter.tabulation.size" - possible values: "<n>", where n is a positive integer - default: "4" FORMATTER / Inserting space in cast expression When Insert, a space is added between the type and the expression in a cast expression. - option id: "org.eclipse.jdt.core.formatter.space.castexpression" - possible values: { "insert", "do not insert" } - default: "insert" CODEASSIST / Activate Visibility Sensitive Completion When active, completion doesn't show that you can not see (for example, you can not see private methods of a super class). - option id: "org.eclipse.jdt.core.codeComplete.visibilityCheck" - possible values: { "enabled", "disabled" } - default: "disabled" CODEASSIST / Automatic Qualification of Implicit Members When active, completion automatically qualifies completion on implicit field references and message expressions. - option id: "org.eclipse.jdt.core.codeComplete.forceImplicitQualification" - possible values: { "enabled", "disabled" } - default: "disabled" CODEASSIST / Define the Prefixes for Field Name When the prefixes is non empty, completion for field name will begin with one of the proposed prefixes. - option id: "org.eclipse.jdt.core.codeComplete.fieldPrefixes" - possible values: { "<prefix>[,<prefix>]*" } where <prefix> is a String without any wild-card - default: "" CODEASSIST / Define the Prefixes for Static Field Name When the prefixes is non empty, completion for static field name will begin with one of the proposed prefixes. - option id: "org.eclipse.jdt.core.codeComplete.staticFieldPrefixes" - possible values: { "<prefix>[,<prefix>]*" } where <prefix> is a String without any wild-card - default: "" CODEASSIST / Define the Prefixes for Local Variable Name When the prefixes is non empty, completion for local variable name will begin with one of the proposed prefixes. - option id: "org.eclipse.jdt.core.codeComplete.localPrefixes" - possible values: { "<prefix>[,<prefix>]*" } where <prefix> is a String without any wild-card - default: "" CODEASSIST / Define the Prefixes for Argument Name When the prefixes is non empty, completion for argument name will begin with one of the proposed prefixes. - option id: "org.eclipse.jdt.core.codeComplete.argumentPrefixes" - possible values: { "<prefix>[,<prefix>]*" } where <prefix> is a String without any wild-card - default: "" CODEASSIST / Define the Suffixes for Field Name When the suffixes is non empty, completion for field name will end with one of the proposed suffixes. - option id: "org.eclipse.jdt.core.codeComplete.fieldSuffixes" - possible values: { "<suffix>[,<suffix>]*" } where <suffix> is a String without any wild-card - default: "" CODEASSIST / Define the Suffixes for Static Field Name When the suffixes is non empty, completion for static field name will end with one of the proposed suffixes. - option id: "org.eclipse.jdt.core.codeComplete.staticFieldSuffixes" - possible values: { "<suffix>[,<suffix>]*" } where <suffix> is a String without any wild-card - default: "" CODEASSIST / Define the Suffixes for Local Variable Name When the suffixes is non empty, completion for local variable name will end with one of the proposed suffixes. - option id: "org.eclipse.jdt.core.codeComplete.localSuffixes" - possible values: { "<suffix>[,<suffix>]*" } where <suffix> is a String without any wild-card - default: "" CODEASSIST / Define the Suffixes for Argument Name When the suffixes is non empty, completion for argument name will end with one of the proposed suffixes. - option id: "org.eclipse.jdt.core.codeComplete.argumentSuffixes" - possible values: { "<suffix>[,<suffix>]*" } where <suffix> is a String without any wild-card - default: "" CODEASSIST / Activate Forbidden Reference Sensitive Completion When active, completion doesn't show that have forbidden reference. - option id: "org.eclipse.jdt.core.codeComplete.forbiddenReferenceCheck" - possible values: { "enabled", "disabled" } - default: "enabled" CODEASSIST / Activate Discouraged Reference Sensitive Completion When active, completion doesn't show that have discouraged reference. - option id: "org.eclipse.jdt.core.codeComplete.discouragedReferenceCheck" - possible values: { "enabled", "disabled" } - default: "disabled"
String
; value type: String
)setOptions(Hashtable)
public static String getEncoding()
IContainer.getDefaultCharset()
,
ResourcesPlugin.getEncoding()
public static JavaCore getJavaCore()
(JavaCore) getPlugin()
.
public static String getOption(String optionName)
(String)JavaCore.getOptions().get(optionName)
Note that it may answer null
if this option does not exist.
For a complete description of the configurable options, see getDefaultOptions
.
optionName
- the name of an option
getDefaultOptions()
,
for changing default settings
public static Hashtable getOptions()
For a complete description of the configurable options, see getDefaultOptions
.
String
; value type: String
)getDefaultOptions()
,
for changing default settings
public static Plugin getPlugin()
public static IClasspathEntry getResolvedClasspathEntry(IClasspathEntry entry)
null
null
Variable source attachment path and root path are also resolved and recorded in the resulting classpath entry.
NOTE: This helper method does not handle classpath containers, for which should rather be used
JavaCore#getClasspathContainer(IPath, IJavaProject)
.
entry
- the given variable entry
null
if the given variable entry could not be resolved to a valid classpath entrypublic static IPath getResolvedVariablePath(IPath variablePath)
variablePath
- the given variable path
null
if nonepublic static IWorkingCopy[] getSharedWorkingCopies(IBufferFactory factory)
IWorkingCopy.getSharedWorkingCopy
.
factory
- the given buffer factory
IWorkingCopy
public static String[] getUserLibraryNames()
public static ICompilationUnit[] getWorkingCopies(WorkingCopyOwner owner)
null
, primary working copies are returned.
owner
- the given working copy owner or public static void initializeAfterLoad(IProgressMonitor monitor) throws CoreException
However calling this method is optional. Services will lazily perform initialization when invoked. This is only a way to reduce initialization overhead on user actions, if it can be performed before at some appropriate moment.
This initialization runs accross all Java projects in the workspace. Thus the workspace root scheduling rule is used during this operation.
This method may return before the initialization is complete. The initialization will then continue in a background thread.
This method can be called concurrently.
monitor
- a progress monitor, or null
if progress
reporting and cancellation are not desired
CoreException
- if the initialization fails,
the status of the exception indicates the reason of the failurepublic static boolean isReferencedBy(IJavaElement element, IMarker marker) throws CoreException
element
- the elementmarker
- the marker
true
if the marker references the element, false otherwise
CoreException
- if the IMarker.getAttribute
on the marker failspublic static boolean isReferencedBy(IJavaElement element, IMarkerDelta markerDelta) throws CoreException
element
- the elementmarkerDelta
- the marker delta
true
if the marker delta references the element
CoreException
- if the IMarkerDelta.getAttribute
on the marker delta failspublic static IAccessRule newAccessRule(IPath filePattern, int kind)
filePattern
- the file pattern this access rule should matchkind
- one of IAccessRule#K_ACCESSIBLE, IAcccessRule#K_STRICTLY_NON_ACCESSIBLE, or IAcccessRule#K_LOOSELY_NON_ACCESSIBLE
public static IClasspathAttribute newClasspathAttribute(String name, String value)
public static IClasspathEntry newContainerEntry(IPath containerPath)
CPE_CONTAINER
for the given path. This method is fully equivalent to calling
newContainerEntry(containerPath, new IAccessRule[0], new IClasspathAttribute[0], false)
.
containerPath
- the path identifying the container, it must be formed of two
segments
getClasspathContainer(IPath, IJavaProject)
public static IClasspathEntry newContainerEntry(IPath containerPath, boolean isExported)
CPE_CONTAINER
for the given path. This method is fully equivalent to calling
newContainerEntry(containerPath, new IAccessRule[0], new IClasspathAttribute[0], isExported)
.
containerPath
- the path identifying the container, it must be formed of at least
one segment (ID+hints)isExported
- a boolean indicating whether this entry is contributed to dependent
projects in addition to the output location
getClasspathContainer(IPath, IJavaProject)
,
setClasspathContainer(IPath, IJavaProject[], IClasspathContainer[], IProgressMonitor)
public static IClasspathEntry newContainerEntry(IPath containerPath, IAccessRule[] accessRules, IClasspathAttribute[] extraAttributes, boolean isExported)
CPE_CONTAINER
for the given path. The path of the container will be used during resolution so as to map this
container entry to a set of other classpath entries the container is acting for.
A container entry allows to express indirect references to a set of libraries, projects and variable entries,
which can be interpreted differently for each Java project where it is used.
A classpath container entry can be resolved using JavaCore.getResolvedClasspathContainer
,
and updated with JavaCore.classpathContainerChanged
A container is exclusively resolved by a ClasspathContainerInitializer
registered onto the
extension point "org.eclipse.jdt.core.classpathContainerInitializer".
A container path must be formed of at least one segment, where:
Example of an ClasspathContainerInitializer for a classpath container denoting a default JDK container:
containerEntry = JavaCore.newContainerEntry(new Path("MyProvidedJDK/default")); <extension point="org.eclipse.jdt.core.classpathContainerInitializer"> <containerInitializer id="MyProvidedJDK" class="com.example.MyInitializer"/>
The access rules determine the set of accessible source and class files
in the container. If the list of access rules is empty, then all files
in this container are accessible.
See IAccessRule
for a detailed description of access
rules. Note that if an entry defined by the container defines access rules,
then these access rules are combined with the given access rules.
The given access rules are considered first, then the entry's access rules are
considered.
The extraAttributes
list contains name/value pairs that must be persisted with
this entry. If no extra attributes are provided, an empty array must be passed in.
Note that this list should not contain any duplicate name.
The isExported
flag indicates whether this entry is contributed to dependent
projects. If not exported, dependent projects will not see any of the classes from this entry.
If exported, dependent projects will concatenate the accessible files patterns of this entry with the
accessible files patterns of the projects, and they will concatenate the non accessible files patterns of this entry
with the non accessible files patterns of the project.
Note that this operation does not attempt to validate classpath containers or access the resources at the given paths.
containerPath
- the path identifying the container, it must be formed of at least
one segment (ID+hints)accessRules
- the possibly empty list of access rules for this entryextraAttributes
- the possibly empty list of extra attributes to persist with this entryisExported
- a boolean indicating whether this entry is contributed to dependent
projects in addition to the output location
getClasspathContainer(IPath, IJavaProject)
,
setClasspathContainer(IPath, IJavaProject[], IClasspathContainer[], IProgressMonitor)
,
newContainerEntry(IPath, boolean)
,
newAccessRule(IPath, int)
public static ITypeHierarchy newTypeHierarchy(IRegion region, WorkingCopyOwner owner, IProgressMonitor monitor) throws JavaModelException
Note that if a working copy is empty, it will be as if the original compilation unit had been deleted.
monitor
- the given progress monitorregion
- the given regionowner
- the owner of working copies that take precedence over their original compilation units,
or null
if the primary working copy owner should be used
JavaModelException
- if an element in the region does not exist or if an
exception occurs while accessing its corresponding resource
IllegalArgumentException
- if region is null
public static IClasspathEntry newLibraryEntry(IPath path, IPath sourceAttachmentPath, IPath sourceAttachmentRootPath)
CPE_LIBRARY
for the
JAR or folder identified by the given absolute path. This specifies that all package fragments
within the root will have children of type IClassFile
.
This method is fully equivalent to calling
newLibraryEntry(path, sourceAttachmentPath, sourceAttachmentRootPath, new IAccessRule[0], new IClasspathAttribute[0], false)
.
path
- the absolute path of the binary archivesourceAttachmentPath
- the absolute path of the corresponding source archive or folder,
or null
if none. Note, since 3.0, an empty path is allowed to denote no source attachment.
and will be automatically converted to null
.sourceAttachmentRootPath
- the location of the root within the source archive or folder
or null
if this location should be automatically detected.
public static IClasspathEntry newLibraryEntry(IPath path, IPath sourceAttachmentPath, IPath sourceAttachmentRootPath, boolean isExported)
CPE_LIBRARY
for the JAR or folder
identified by the given absolute path. This specifies that all package fragments within the root
will have children of type IClassFile
.
This method is fully equivalent to calling
newLibraryEntry(path, sourceAttachmentPath, sourceAttachmentRootPath, new IAccessRule[0], new IClasspathAttribute[0], isExported)
.
path
- the absolute path of the binary archivesourceAttachmentPath
- the absolute path of the corresponding source archive or folder,
or null
if none. Note, since 3.0, an empty path is allowed to denote no source attachment.
and will be automatically converted to null
.sourceAttachmentRootPath
- the location of the root within the source archive or folder
or null
if this location should be automatically detected.isExported
- indicates whether this entry is contributed to dependent
projects in addition to the output location
public static IClasspathEntry newLibraryEntry(IPath path, IPath sourceAttachmentPath, IPath sourceAttachmentRootPath, IAccessRule[] accessRules, IClasspathAttribute[] extraAttributes, boolean isExported)
CPE_LIBRARY
for the JAR or folder
identified by the given absolute path. This specifies that all package fragments within the root
will have children of type IClassFile
.
A library entry is used to denote a prerequisite JAR or root folder containing binaries. The target JAR can either be defined internally to the workspace (absolute path relative to the workspace root) or externally to the workspace (absolute path in the file system). The target root folder can only be defined internally to the workspace (absolute path relative to the workspace root). To use a binary folder external to the workspace, it must first be linked (see IFolder#createLink(...)).
e.g. Here are some examples of binary path usage
"c:/jdk1.2.2/jre/lib/rt.jar"
- reference to an external JAR "/Project/someLib.jar"
- reference to an internal JAR "/Project/classes/"
- reference to an internal binary folder
The access rules determine the set of accessible class files
in the library. If the list of access rules is empty then all files
in this library are accessible.
See IAccessRule
for a detailed description of access
rules.
The extraAttributes
list contains name/value pairs that must be persisted with
this entry. If no extra attributes are provided, an empty array must be passed in.
Note that this list should not contain any duplicate name.
The isExported
flag indicates whether this entry is contributed to dependent
projects. If not exported, dependent projects will not see any of the classes from this entry.
If exported, dependent projects will concatenate the accessible files patterns of this entry with the
accessible files patterns of the projects, and they will concatenate the non accessible files patterns of this entry
with the non accessible files patterns of the project.
path
- the absolute path of the binary archivesourceAttachmentPath
- the absolute path of the corresponding source archive or folder,
or null
if none. Note, since 3.0, an empty path is allowed to denote no source attachment.
and will be automatically converted to null
.sourceAttachmentRootPath
- the location of the root within the source archive or folder
or null
if this location should be automatically detected.accessRules
- the possibly empty list of access rules for this entryextraAttributes
- the possibly empty list of extra attributes to persist with this entryisExported
- indicates whether this entry is contributed to dependent
projects in addition to the output location
public static IClasspathEntry newProjectEntry(IPath path)
CPE_PROJECT
for the project identified by the given absolute path.
This method is fully equivalent to calling
newProjectEntry(path, new IAccessRule[0], true, new IClasspathAttribute[0], false)
.
path
- the absolute path of the binary archive
public static IClasspathEntry newProjectEntry(IPath path, boolean isExported)
CPE_PROJECT
for the project identified by the given absolute path.
This method is fully equivalent to calling
newProjectEntry(path, new IAccessRule[0], true, new IClasspathAttribute[0], isExported)
.
path
- the absolute path of the prerequisite projectisExported
- indicates whether this entry is contributed to dependent
projects in addition to the output location
public static IClasspathEntry newProjectEntry(IPath path, IAccessRule[] accessRules, boolean combineAccessRules, IClasspathAttribute[] extraAttributes, boolean isExported)
CPE_PROJECT
for the project identified by the given absolute path.
A project entry is used to denote a prerequisite project on a classpath. The referenced project will be contributed as a whole, either as sources (in the Java Model, it contributes all its package fragment roots) or as binaries (when building, it contributes its whole output location).
A project reference allows to indirect through another project, independently from its internal layout.
The prerequisite project is referred to using an absolute path relative to the workspace root.
The access rules determine the set of accessible class files
in the project. If the list of access rules is empty then all files
in this project are accessible.
See IAccessRule
for a detailed description of access rules.
The combineAccessRules
flag indicates whether access rules of one (or more)
exported entry of the project should be combined with the given access rules. If they should
be combined, the given access rules are considered first, then the entry's access rules are
considered.
The extraAttributes
list contains name/value pairs that must be persisted with
this entry. If no extra attributes are provided, an empty array must be passed in.
Note that this list should not contain any duplicate name.
The isExported
flag indicates whether this entry is contributed to dependent
projects. If not exported, dependent projects will not see any of the classes from this entry.
If exported, dependent projects will concatenate the accessible files patterns of this entry with the
accessible files patterns of the projects, and they will concatenate the non accessible files patterns of this entry
with the non accessible files patterns of the project.
path
- the absolute path of the prerequisite projectaccessRules
- the possibly empty list of access rules for this entrycombineAccessRules
- whether the access rules of the project's exported entries should be combined with the given access rulesextraAttributes
- the possibly empty list of extra attributes to persist with this entryisExported
- indicates whether this entry is contributed to dependent
projects in addition to the output location
public static IRegion newRegion()
public static IClasspathEntry newSourceEntry(IPath path)
CPE_SOURCE
for all files in the project's source folder identified by the given
absolute workspace-relative path.
The convenience method is fully equivalent to:
newSourceEntry(path, new IPath[] {}, new IPath[] {}, null);
path
- the absolute workspace-relative path of a source folder
newSourceEntry(IPath, IPath[], IPath[], IPath)
public static IClasspathEntry newSourceEntry(IPath path, IPath[] exclusionPatterns)
CPE_SOURCE
for the project's source folder identified by the given absolute
workspace-relative path but excluding all source files with paths
matching any of the given patterns.
The convenience method is fully equivalent to:
newSourceEntry(path, new IPath[] {}, exclusionPatterns, null);
path
- the absolute workspace-relative path of a source folderexclusionPatterns
- the possibly empty list of exclusion patterns
represented as relative paths
newSourceEntry(IPath, IPath[], IPath[], IPath)
public static IClasspathEntry newSourceEntry(IPath path, IPath[] exclusionPatterns, IPath specificOutputLocation)
CPE_SOURCE
for the project's source folder identified by the given absolute
workspace-relative path but excluding all source files with paths
matching any of the given patterns, and associated with a specific output location
(that is, ".class" files are not going to the project default output location).
The convenience method is fully equivalent to:
newSourceEntry(path, new IPath[] {}, exclusionPatterns, specificOutputLocation);
path
- the absolute workspace-relative path of a source folderexclusionPatterns
- the possibly empty list of exclusion patterns
represented as relative pathsspecificOutputLocation
- the specific output location for this source entry (null
if using project default ouput location)
newSourceEntry(IPath, IPath[], IPath[], IPath)
public static IClasspathEntry newSourceEntry(IPath path, IPath[] inclusionPatterns, IPath[] exclusionPatterns, IPath specificOutputLocation)
CPE_SOURCE
for the project's source folder identified by the given absolute
workspace-relative path but excluding all source files with paths
matching any of the given patterns, and associated with a specific output location
(that is, ".class" files are not going to the project default output location).
The convenience method is fully equivalent to:
newSourceEntry(path, new IPath[] {}, exclusionPatterns, specificOutputLocation, new IClasspathAttribute[] {});
path
- the absolute workspace-relative path of a source folderinclusionPatterns
- the possibly empty list of inclusion patterns
represented as relative pathsexclusionPatterns
- the possibly empty list of exclusion patterns
represented as relative pathsspecificOutputLocation
- the specific output location for this source entry (null
if using project default ouput location)
newSourceEntry(IPath, IPath[], IPath[], IPath, IClasspathAttribute[])
public static IClasspathEntry newSourceEntry(IPath path, IPath[] inclusionPatterns, IPath[] exclusionPatterns, IPath specificOutputLocation, IClasspathAttribute[] extraAttributes)
CPE_SOURCE
for the project's source folder identified by the given absolute
workspace-relative path using the given inclusion and exclusion patterns
to determine which source files are included, and the given output path
to control the output location of generated files.
The source folder is referred to using an absolute path relative to the
workspace root, e.g. /Project/src
. A project's source
folders are located with that project. That is, a source classpath
entry specifying the path /P1/src
is only usable for
project P1
.
The inclusion patterns determines the initial set of source files that
are to be included; the exclusion patterns are then used to reduce this
set. When no inclusion patterns are specified, the initial file set
includes all relevent files in the resource tree rooted at the source
entry's path. On the other hand, specifying one or more inclusion
patterns means that all and only files matching at least one of
the specified patterns are to be included. If exclusion patterns are
specified, the initial set of files is then reduced by eliminating files
matched by at least one of the exclusion patterns. Inclusion and
exclusion patterns look like relative file paths with wildcards and are
interpreted relative to the source entry's path. File patterns are
case-sensitive can contain '**', '*' or '?' wildcards (see
IClasspathEntry.getExclusionPatterns()
for the full description
of their syntax and semantics). The resulting set of files are included
in the corresponding package fragment root; all package fragments within
the root will have children of type ICompilationUnit
.
For example, if the source folder path is
/Project/src
, there are no inclusion filters, and the
exclusion pattern is
com/xyz/tests/**
, then source files
like /Project/src/com/xyz/Foo.java
and /Project/src/com/xyz/utils/Bar.java
would be included,
whereas /Project/src/com/xyz/tests/T1.java
and /Project/src/com/xyz/tests/quick/T2.java
would be
excluded.
Additionally, a source entry can be associated with a specific output location.
By doing so, the Java builder will ensure that the generated ".class" files will
be issued inside this output location, as opposed to be generated into the
project default output location (when output location is null
).
Note that multiple source entries may target the same output location.
The output location is referred to using an absolute path relative to the
workspace root, e.g. "/Project/bin"
, it must be located inside
the same project as the source folder.
Also note that all sources/binaries inside a project are contributed as
a whole through a project entry
(see JavaCore.newProjectEntry
). Particular source entries
cannot be selectively exported.
The extraAttributes
list contains name/value pairs that must be persisted with
this entry. If no extra attributes are provided, an empty array must be passed in.
Note that this list should not contain any duplicate name.
path
- the absolute workspace-relative path of a source folderinclusionPatterns
- the possibly empty list of inclusion patterns
represented as relative pathsexclusionPatterns
- the possibly empty list of exclusion patterns
represented as relative pathsspecificOutputLocation
- the specific output location for this source entry (null
if using project default ouput location)extraAttributes
- the possibly empty list of extra attributes to persist with this entry
IClasspathEntry.getInclusionPatterns()
,
IClasspathEntry.getExclusionPatterns()
,
IClasspathEntry.getOutputLocation()
public static IClasspathEntry newVariableEntry(IPath variablePath, IPath variableSourceAttachmentPath, IPath sourceAttachmentRootPath)
CPE_VARIABLE
for the given path. This method is fully equivalent to calling
newVariableEntry(variablePath, variableSourceAttachmentPath, sourceAttachmentRootPath, new IAccessRule[0], new IClasspathAttribute[0], false)
.
variablePath
- the path of the binary archive; first segment is the
name of a classpath variablevariableSourceAttachmentPath
- the path of the corresponding source archive,
or null
if none; if present, the first segment is the
name of a classpath variable (not necessarily the same variable
as the one that begins variablePath
)sourceAttachmentRootPath
- the location of the root within the source archive
or null
if archivePath
is also null
public static IClasspathEntry newVariableEntry(IPath variablePath, IPath variableSourceAttachmentPath, IPath variableSourceAttachmentRootPath, boolean isExported)
CPE_VARIABLE
for the given path. This method is fully equivalent to calling
newVariableEntry(variablePath, variableSourceAttachmentPath, sourceAttachmentRootPath, new IAccessRule[0], new IClasspathAttribute[0], isExported)
.
variablePath
- the path of the binary archive; first segment is the
name of a classpath variablevariableSourceAttachmentPath
- the path of the corresponding source archive,
or null
if none; if present, the first segment is the
name of a classpath variable (not necessarily the same variable
as the one that begins variablePath
)variableSourceAttachmentRootPath
- the location of the root within the source archive
or null
if archivePath
is also null
isExported
- indicates whether this entry is contributed to dependent
projects in addition to the output location
public static IClasspathEntry newVariableEntry(IPath variablePath, IPath variableSourceAttachmentPath, IPath variableSourceAttachmentRootPath, IAccessRule[] accessRules, IClasspathAttribute[] extraAttributes, boolean isExported)
CPE_VARIABLE
for the given path. The first segment of the path is the name of a classpath variable.
The trailing segments of the path will be appended to resolved variable path.
A variable entry allows to express indirect references on a classpath to other projects or libraries, depending on what the classpath variable is referring.
It is possible to register an automatic initializer (ClasspathVariableInitializer
),
which will be invoked through the extension point "org.eclipse.jdt.core.classpathVariableInitializer".
After resolution, a classpath variable entry may either correspond to a project or a library entry.
e.g. Here are some examples of variable path usage
JDTCORE
is
bound to "c:/jars/jdtcore.jar". The resolved classpath entry is denoting the library "c:\jars\jdtcore.jar"JDTCORE
is
bound to "/Project_JDTCORE". The resolved classpath entry is denoting the project "/Project_JDTCORE"PLUGINS
is bound to "c:/eclipse/plugins". The resolved classpath entry is denoting the library "c:/eclipse/plugins/com.example/example.jar"
The access rules determine the set of accessible class files
in the project or library. If the list of access rules is empty then all files
in this project or library are accessible.
See IAccessRule
for a detailed description of access rules.
The extraAttributes
list contains name/value pairs that must be persisted with
this entry. If no extra attributes are provided, an empty array must be passed in.
Note that this list should not contain any duplicate name.
The isExported
flag indicates whether this entry is contributed to dependent
projects. If not exported, dependent projects will not see any of the classes from this entry.
If exported, dependent projects will concatenate the accessible files patterns of this entry with the
accessible files patterns of the projects, and they will concatenate the non accessible files patterns of this entry
with the non accessible files patterns of the project.
Note that this operation does not attempt to validate classpath variables or access the resources at the given paths.
variablePath
- the path of the binary archive; first segment is the
name of a classpath variablevariableSourceAttachmentPath
- the path of the corresponding source archive,
or null
if none; if present, the first segment is the
name of a classpath variable (not necessarily the same variable
as the one that begins variablePath
)variableSourceAttachmentRootPath
- the location of the root within the source archive
or null
if archivePath
is also null
accessRules
- the possibly empty list of access rules for this entryextraAttributes
- the possibly empty list of extra attributes to persist with this entryisExported
- indicates whether this entry is contributed to dependent
projects in addition to the output location
public static void removeClasspathVariable(String variableName)
This functionality cannot be used while the resource tree is locked.
Classpath variable values are persisted locally to the workspace, and are preserved from session to session.
variableName
- the name of the classpath variablesetClasspathVariable(String, IPath)
public static void removeClasspathVariable(String variableName, IProgressMonitor monitor)
This functionality cannot be used while the resource tree is locked.
Classpath variable values are persisted locally to the workspace, and are preserved from session to session.
variableName
- the name of the classpath variablemonitor
- the progress monitor to report progresssetClasspathVariable(String, IPath)
public static void removeElementChangedListener(IElementChangedListener listener)
listener
- the listenerpublic static void removePreProcessingResourceChangedListener(IResourceChangeListener listener)
Has no affect if an identical listener is not registered.
listener
- the listenerpublic static void run(IWorkspaceRunnable action, IProgressMonitor monitor) throws CoreException
After running a method that modifies java elements, registered listeners receive after-the-fact notification of what just transpired, in the form of a element changed event. This method allows clients to call a number of methods that modify java elements and only have element changed event notifications reported at the end of the entire batch.
If this method is called outside the dynamic scope of another such call, this method runs the action and then reports a single element changed event describing the net effect of all changes done to java elements by the action.
If this method is called in the dynamic scope of another such call, this method simply runs the action.
action
- the action to performmonitor
- a progress monitor, or null
if progress
reporting and cancellation are not desired
CoreException
- if the operation failed.public static void run(IWorkspaceRunnable action, ISchedulingRule rule, IProgressMonitor monitor) throws CoreException
After running a method that modifies java elements, registered listeners receive after-the-fact notification of what just transpired, in the form of a element changed event. This method allows clients to call a number of methods that modify java elements and only have element changed event notifications reported at the end of the entire batch.
If this method is called outside the dynamic scope of another such call, this method runs the action and then reports a single element changed event describing the net effect of all changes done to java elements by the action.
If this method is called in the dynamic scope of another such call, this method simply runs the action.
The supplied scheduling rule is used to determine whether this operation can be
run simultaneously with workspace changes in other threads. See
IWorkspace.run(...)
for more details.
action
- the action to performrule
- the scheduling rule to use when running this operation, or
null
if there are no scheduling restrictions for this operation.monitor
- a progress monitor, or null
if progress
reporting and cancellation are not desired
CoreException
- if the operation failed.public static void setClasspathContainer(IPath containerPath, IJavaProject[] affectedProjects, IClasspathContainer[] respectiveContainers, IProgressMonitor monitor) throws JavaModelException
IClasspathContainer
).
This API must be invoked whenever changes in container need to be reflected onto the JavaModel.
Containers can have distinct values in different projects, therefore this API considers a
set of projects with their respective containers.
containerPath
is the path under which these values can be referenced through
container classpath entries (IClasspathEntry#CPE_CONTAINER
). A container path
is formed by a first ID segment followed with extra segments, which can be used as additional hints
for the resolution. The container ID is used to identify a ClasspathContainerInitializer
registered on the extension point "org.eclipse.jdt.core.classpathContainerInitializer".
There is no assumption that each individual container value passed in argument
(respectiveContainers
) must answer the exact same path when requested
IClasspathContainer#getPath
.
Indeed, the containerPath is just an indication for resolving it to an actual container object. It can be
delegated to a ClasspathContainerInitializer
, which can be activated through the extension
point "org.eclipse.jdt.core.ClasspathContainerInitializer").
In reaction to changing container values, the JavaModel will be updated to reflect the new state of the updated container. A combined Java element delta will be notified to describe the corresponding classpath changes resulting from the container update. This operation is batched, and automatically eliminates unnecessary updates (new container is same as old one). This operation acquires a lock on the workspace's root.
This functionality cannot be used while the workspace is locked, since it may create/remove some resource markers.
Classpath container values are persisted locally to the workspace, but
are not preserved from a session to another. It is thus highly recommended to register a
ClasspathContainerInitializer
for each referenced container
(through the extension point "org.eclipse.jdt.core.ClasspathContainerInitializer").
Note: setting a container to null
will cause it to be lazily resolved again whenever
its value is required. In particular, this will cause a registered initializer to be invoked
again.
containerPath
- - the name of the container reference, which is being updatedaffectedProjects
- - the set of projects for which this container is being boundrespectiveContainers
- - the set of respective containers for the affected projectsmonitor
- a monitor to report progress
JavaModelException
ClasspathContainerInitializer
,
getClasspathContainer(IPath, IJavaProject)
,
IClasspathContainer
public static void setClasspathVariable(String variableName, IPath path) throws JavaModelException
This functionality cannot be used while the resource tree is locked.
Classpath variable values are persisted locally to the workspace, and are preserved from session to session.
variableName
- the name of the classpath variablepath
- the path
JavaModelException
getClasspathVariable(String)
public static void setClasspathVariable(String variableName, IPath path, IProgressMonitor monitor) throws JavaModelException
This functionality cannot be used while the resource tree is locked.
Classpath variable values are persisted locally to the workspace, and are preserved from session to session.
Updating a variable with the same value has no effect.
variableName
- the name of the classpath variablepath
- the pathmonitor
- a monitor to report progress
JavaModelException
getClasspathVariable(String)
public static void setClasspathVariables(String[] variableNames, IPath[] paths, IProgressMonitor monitor) throws JavaModelException
A combined Java element delta will be notified to describe the corresponding classpath changes resulting from the variables update. This operation is batched, and automatically eliminates unnecessary updates (new variable is same as old one). This operation acquires a lock on the workspace's root.
This functionality cannot be used while the workspace is locked, since it may create/remove some resource markers.
Classpath variable values are persisted locally to the workspace, and are preserved from session to session.
Updating a variable with the same value has no effect.
variableNames
- an array of names for the updated classpath variablespaths
- an array of path updates for the modified classpath variables (null
meaning that the corresponding value will be removedmonitor
- a monitor to report progress
JavaModelException
getClasspathVariable(String)
public static void setOptions(Hashtable newOptions)
For a complete description of the configurable options, see getDefaultOptions
.
newOptions
- the new options (key type: String
; value type: String
),
or null
to reset all options to their default valuesgetDefaultOptions()
,
for changing default settings
public void stop(BundleContext context) throws Exception
Exception
public void start(BundleContext context) throws Exception
Exception
|
Eclipse JDT Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |