net.officefloor.eclipse.classpathcontainer
Class OfficeFloorClasspathContainerInitialiser

java.lang.Object
  org.eclipse.jdt.core.ClasspathContainerInitializer
      net.officefloor.eclipse.classpathcontainer.OfficeFloorClasspathContainerInitialiser

public class OfficeFloorClasspathContainerInitialiser
extends org.eclipse.jdt.core.ClasspathContainerInitializer

ClasspathContainerInitializer for the OfficeFloor.

Author:

Daniel Sagenschneider

Field Summary

static String	CONFIGURATION_FILE_NAME Name of file containing the OfficeFloorClasspathContainer configuration.
static org.eclipse.core.runtime.IPath	OFFICE_FLOOR_CLASSPATH_CONTAINER_PATH IPath for the OfficeFloorClasspathContainer.

Fields inherited from class org.eclipse.jdt.core.ClasspathContainerInitializer

ATTRIBUTE_NOT_SUPPORTED, ATTRIBUTE_READ_ONLY

Constructor Summary

OfficeFloorClasspathContainerInitialiser()

Method Summary

static void	addExtensionClasspathProvidersToOfficeFloorClassPath(org.eclipse.jdt.core.IJavaProject project, org.eclipse.core.runtime.IProgressMonitor monitor, String... extensionClassNames) Adds the ExtensionClasspathProvider entries to the OfficeFloorClasspathContainer.
boolean	canUpdateClasspathContainer(org.eclipse.core.runtime.IPath containerPath, org.eclipse.jdt.core.IJavaProject project)
static void	ensureOfficeFloorClasspathContainerOnProject(org.eclipse.jdt.core.IJavaProject project, org.eclipse.core.runtime.IProgressMonitor monitor) Ensures the OfficeFloorClasspathContainer is on the IJavaProject class path.
void	initialize(org.eclipse.core.runtime.IPath containerPath, org.eclipse.jdt.core.IJavaProject project)
void	requestClasspathContainerUpdate(org.eclipse.core.runtime.IPath containerPath, org.eclipse.jdt.core.IJavaProject project, org.eclipse.jdt.core.IClasspathContainer containerSuggestion)

Methods inherited from class org.eclipse.jdt.core.ClasspathContainerInitializer

getAccessRulesStatus, getAttributeStatus, getComparisonID, getDescription, getFailureContainer, getSourceAttachmentStatus

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONFIGURATION_FILE_NAME

public static final String CONFIGURATION_FILE_NAME

Name of file containing the OfficeFloorClasspathContainer configuration.

See Also:

Constant Field Values

OFFICE_FLOOR_CLASSPATH_CONTAINER_PATH

public static final org.eclipse.core.runtime.IPath OFFICE_FLOOR_CLASSPATH_CONTAINER_PATH

IPath for the OfficeFloorClasspathContainer.

Constructor Detail

OfficeFloorClasspathContainerInitialiser

public OfficeFloorClasspathContainerInitialiser()

Method Detail

ensureOfficeFloorClasspathContainerOnProject

public static void ensureOfficeFloorClasspathContainerOnProject(org.eclipse.jdt.core.IJavaProject project,
                                                                org.eclipse.core.runtime.IProgressMonitor monitor)
                                                         throws org.eclipse.core.runtime.CoreException

Ensures the OfficeFloorClasspathContainer is on the IJavaProject class path.

Parameters:

project - IJavaProject to check for the OfficeFloorClasspathContainer.

monitor - IProgressMonitor. May be null.

Throws:

org.eclipse.core.runtime.CoreException - If fails in checking or adding the OfficeFloorClasspathContainer to the IJavaProject.

addExtensionClasspathProvidersToOfficeFloorClassPath

public static void addExtensionClasspathProvidersToOfficeFloorClassPath(org.eclipse.jdt.core.IJavaProject project,
                                                                        org.eclipse.core.runtime.IProgressMonitor monitor,
                                                                        String... extensionClassNames)
                                                                 throws org.eclipse.core.runtime.CoreException

Adds the ExtensionClasspathProvider entries to the OfficeFloorClasspathContainer.

This method also ensures the OfficeFloorClasspathContainer is added to the IJavaProject.

Parameters:

project - IJavaProject to add the ExtensionClasspathProvider entries.

monitor - IProgressMonitor. May be null.

extensionClassNames - Listing of ExtensionClasspathProvider class names to add.

Throws:

org.eclipse.core.runtime.CoreException - If fails to add ExtensionClasspathProvider entries.

initialize

public void initialize(org.eclipse.core.runtime.IPath containerPath,
                       org.eclipse.jdt.core.IJavaProject project)
                throws org.eclipse.core.runtime.CoreException

Specified by:

initialize in class org.eclipse.jdt.core.ClasspathContainerInitializer

Throws:

org.eclipse.core.runtime.CoreException

canUpdateClasspathContainer

public boolean canUpdateClasspathContainer(org.eclipse.core.runtime.IPath containerPath,
                                           org.eclipse.jdt.core.IJavaProject project)

Overrides:

canUpdateClasspathContainer in class org.eclipse.jdt.core.ClasspathContainerInitializer

requestClasspathContainerUpdate

public void requestClasspathContainerUpdate(org.eclipse.core.runtime.IPath containerPath,
                                            org.eclipse.jdt.core.IJavaProject project,
                                            org.eclipse.jdt.core.IClasspathContainer containerSuggestion)
                                     throws org.eclipse.core.runtime.CoreException

Overrides:

requestClasspathContainerUpdate in class org.eclipse.jdt.core.ClasspathContainerInitializer

Throws:

org.eclipse.core.runtime.CoreException