Eclipse JDT Plug-in Developer Guide (Galileo) - IFactoryPath (Eclipse JDT API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse JDT
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jdt.apt.core.util
Interface IFactoryPath

public interface IFactoryPath

A minimal API for manipulating the annotation processor factory path. The factory path is an ordered list of containers, each of which has certain attributes, e.g., isEnabled, runInBatchMode. Containers on the path do not necessarily contain implementations of any particular service; in particular, a path may have both Java 5 and Java 6 annotation processors, as well as entries that contain supporting classes or resources.

Clients should not implement this interface.

Method Summary

void addExternalJar ( File jar)
          Add an external jar file (not in the workspace) to the head of the factory path.

void addVarJar ( IPath jarPath)
          Add a jar file in the workspace, specified with a classpath variable, to the head of the factory path.

void addWkspJar ( IPath jarPath)
          Add a jar file in the workspace to the head of the factory path.

void disablePlugin ( String pluginId)
          Disable a plugin on the factory path.

void enablePlugin ( String pluginId)
          Enable a plugin on the factory path, and move it to the head of the path.

void removeExternalJar ( File jar)
          Remove an external jar file from the factory path.

void removeVarJar ( IPath jarPath)
          Remove from the factory path a jar file whose name is based on a classpath variable.

void removeWkspJar ( IPath jarPath)
          Remove a workspace-relative jar from the factory path.

Method Detail

addExternalJar

void addExternalJar(
File jar)

Add an external jar file (not in the workspace) to the head of the factory path. If the jar is already on the path, move it to the head. The jar will be added with default attributes, e.g., isEnabled=true, runInBatchMode=false.

Parameters:: jar - a java.io.File representing the jar file. Must not be null.

removeExternalJar

void removeExternalJar(
File jar)

Remove an external jar file from the factory path. If the jar isn't on the path, do nothing.

Parameters:: jar - must not be null.

addWkspJar

void addWkspJar(
IPath jarPath)

Add a jar file in the workspace to the head of the factory path. If the jar is already on the path, move it to the head. The jar will be added with default attributes, e.g., isEnabled=true, runInBatchMode=false.

Parameters:: jarPath - an Eclipse IPath representing the jar file; the path is relative to the workspace root. Must not be null.

removeWkspJar

void removeWkspJar(
IPath jarPath)

Remove a workspace-relative jar from the factory path. If the jar isn't on the path, do nothing.

Parameters:: jarPath - an Eclipse IPath representing the jar file; the path is relative to the workspace root. Must not be null.

addVarJar

void addVarJar(
IPath jarPath)

Add a jar file in the workspace, specified with a classpath variable, to the head of the factory path. If the jar is already on the path, move it to the head. The jar will be added with default attributes, e.g., isEnabled=true, runInBatchMode=false.

Parameters:: jarPath - an Eclipse IPath representing the jar file; the first segment of the path is assumed to be the variable name. Must not be null.

removeVarJar

void removeVarJar(
IPath jarPath)

Remove from the factory path a jar file whose name is based on a classpath variable. If the jar isn't on the path, do nothing.

Parameters:: jarPath - an Eclipse IPath representing the jar file; the first segment of the path is assumed to be the variable name. Must not be null.

enablePlugin

void enablePlugin(
String pluginId)
                  throws 
CoreException

Enable a plugin on the factory path, and move it to the head of the path.

Parameters:: pluginId - the unique id of the processor plugin, e.g., "org.example.myProcessors"
Throws:: CoreException - if the plugin is not installed.

disablePlugin

void disablePlugin(
String pluginId)

Disable a plugin on the factory path. If the plugin is not installed, do nothing.

Parameters:: pluginId - the unique id of the processor plugin, e.g., "org.example.myProcessors"