Class EclipseConfigurator

java.lang.Object

org.jdrupes.builder.core.AbstractProvider

org.jdrupes.builder.core.AbstractGenerator

org.jdrupes.builder.eclipse.EclipseConfigurator

All Implemented Interfaces:

Generator, ResourceProvider

public class EclipseConfigurator
extends AbstractGenerator

The EclipseConfigurator provides the resource EclipseConfiguration. "The configuration" consists of the Eclipse configuration files for a given project. The configurator generates the following files as W3C DOM documents (for XML files) or as Properties for a given project:

• .project,
• .classpath,
• .settings/org.eclipse.core.resources.prefs,
• .settings/org.eclipse.core.runtime.prefs and
• .settings/org.eclipse.jdt.core.prefs.

Each generated data structure can be post processed by a corresponding adapt method before being written to disk. Additional resources can be generated by the method adaptConfiguration(Runnable).

Eclipse provides project nesting, but the outer project does not define a namespace. This can lead to problems if you have multiple (sub)projects in the workspace with the same name. The configurator allows you to define an alias for the project name to avoid this problem. The alias is used as Eclipse project name in all generated files.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EclipseConfigurator.ProjectConfigurationAdaptor	Allow derived classes to post process the project configuration.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GENERATED_BY	The Constant GENERATED_BY.

Fields inherited from class AbstractProvider

log

Constructor Summary

Constructors

Constructor	Description
EclipseConfigurator(Project project)	Instantiates a new eclipse configurator.

Method Summary

Modifier and Type	Method	Description
EclipseConfigurator	adaptClasspathConfiguration(BiConsumer<Document,Node> adaptor)	Allow the user to post process the classpath configuration.
EclipseConfigurator	adaptConfiguration(Runnable adaptor)	Allow the user to add additional resources.
EclipseConfigurator	adaptJdtCorePrefs(Consumer<Properties> adaptor)	Allow the user to adapt the properties for the .settings/org.eclipse.jdt.core.prefs file.
EclipseConfigurator	adaptProjectConfiguration(EclipseConfigurator.ProjectConfigurationAdaptor adaptor)	Adapt project configuration.
EclipseConfigurator	adaptResourcePrefs(Consumer<Properties> adaptor)	Allow the user to adapt the properties for the .settings/org.eclipse.core.resources.prefs file.
EclipseConfigurator	adaptRuntimePrefs(Consumer<Properties> adaptor)	Allow the user to adapt the properties for the .settings/org.eclipse.core.runtime.prefs file.
protected <T extends Resource> Stream<T>	doProvide(ResourceRequest<T> requested)	Provides an EclipseConfiguration.
String	eclipseAlias()	Returns the eclipse alias.
EclipseConfigurator	eclipseAlias(String eclipseAlias)	Define the eclipse (alias) project name.
EclipseConfigurator	eclipseAlias(Supplier<String> eclipseAlias)	Define the eclipse (alias) project name.
protected void	generateClasspathConfiguration(Document doc)	Generates the content of the .classpath file into the given document.
protected void	generateJdtCorePrefs()	Generate the properties for the .settings/org.eclipse.jdt.core.prefs file.
protected void	generateProjectConfiguration(Document doc)	Generates the content of the .project file into the given document.
protected void	generateResourcesPrefs()	Generate the properties for the .settings/org.eclipse.core.resources.prefs file.
protected void	generateRuntimePrefs()	Generate the properties for the .settings/org.eclipse.core.runtime.prefs file.

Methods inherited from class AbstractGenerator

cleanup, name, name, newResource, project, toString

Methods inherited from class AbstractProvider

provide

Methods inherited from class Object

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

Methods inherited from interface ResourceProvider

provide

Field Details

GENERATED_BY

public static final String GENERATED_BY

The Constant GENERATED_BY.

See Also:

• Constant Field Values

Constructor Details

EclipseConfigurator

public EclipseConfigurator(Project project)

Instantiates a new eclipse configurator.

Parameters:

project - the project

Method Details

eclipseAlias

public EclipseConfigurator eclipseAlias(Supplier<String> eclipseAlias)

Define the eclipse (alias) project name.

Parameters:

eclipseAlias - the eclipse alias

Returns:

the eclipse configurator

eclipseAlias

public EclipseConfigurator eclipseAlias(String eclipseAlias)

Define the eclipse (alias) project name.

Parameters:

eclipseAlias - the eclipse alias

Returns:

the eclipse configurator

eclipseAlias

public String eclipseAlias()

Returns the eclipse alias.

Returns:

the string

doProvide

protected <T extends Resource> Stream<T> doProvide(ResourceRequest<T> requested)

Provides an EclipseConfiguration.

Specified by:

doProvide in class AbstractProvider

Type Parameters:

T - the generic type

Parameters:

requested - the requested

Returns:

the stream

generateProjectConfiguration

protected void generateProjectConfiguration(Document doc)

Generates the content of the .project file into the given document.

Parameters:

doc - the document

adaptProjectConfiguration

public EclipseConfigurator adaptProjectConfiguration(EclipseConfigurator.ProjectConfigurationAdaptor adaptor)

Adapt project configuration.

Parameters:

adaptor - the adaptor

Returns:

the eclipse configurator

generateClasspathConfiguration

protected void generateClasspathConfiguration(Document doc)

Generates the content of the .classpath file into the given document.

Parameters:

doc - the doc

adaptClasspathConfiguration

public EclipseConfigurator adaptClasspathConfiguration(BiConsumer<Document,Node> adaptor)

Allow the user to post process the classpath configuration. The node passed to the consumer is the classpath element.

Parameters:

adaptor - the adaptor

Returns:

the eclipse configurator

generateResourcesPrefs

protected void generateResourcesPrefs()

Generate the properties for the .settings/org.eclipse.core.resources.prefs file.

adaptResourcePrefs

public EclipseConfigurator adaptResourcePrefs(Consumer<Properties> adaptor)

Allow the user to adapt the properties for the .settings/org.eclipse.core.resources.prefs file.

Parameters:

adaptor - the adaptor

Returns:

the eclipse configurator

generateRuntimePrefs

protected void generateRuntimePrefs()

Generate the properties for the .settings/org.eclipse.core.runtime.prefs file.

adaptRuntimePrefs

public EclipseConfigurator adaptRuntimePrefs(Consumer<Properties> adaptor)

Allow the user to adapt the properties for the .settings/org.eclipse.core.runtime.prefs file.

Parameters:

adaptor - the adaptor

Returns:

the eclipse configurator

generateJdtCorePrefs

protected void generateJdtCorePrefs()

Generate the properties for the .settings/org.eclipse.jdt.core.prefs file.

adaptJdtCorePrefs

public EclipseConfigurator adaptJdtCorePrefs(Consumer<Properties> adaptor)

Allow the user to adapt the properties for the .settings/org.eclipse.jdt.core.prefs file.

Parameters:

adaptor - the adaptor

Returns:

the eclipse configurator

adaptConfiguration

public EclipseConfigurator adaptConfiguration(Runnable adaptor)

Allow the user to add additional resources.

Parameters:

adaptor - the adaptor

Returns:

the eclipse configurator