org.eclipse.m2e.core.project.conversion

Class AbstractProjectConversionParticipant

java.lang.Object

org.eclipse.m2e.core.project.conversion.AbstractProjectConversionParticipant

All Implemented Interfaces:

org.eclipse.core.runtime.IExecutableExtension

Direct Known Subclasses:

JavaProjectConversionParticipant

public abstract class AbstractProjectConversionParticipant
extends Object
implements org.eclipse.core.runtime.IExecutableExtension

Used to convert existing Eclipse project configuration to the corresponding Maven Model.

Since:

1.1

Author:

Fred Bricon

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_AFTER
static String	ATTR_BEFORE
static String	ATTR_ID
static String	ATTR_NAME
protected Set<String>	restrictedPackagings

Constructor Summary

Constructors

Constructor and Description
AbstractProjectConversionParticipant()

Method Summary

Modifier and Type	Method and Description
abstract boolean	accept(org.eclipse.core.resources.IProject project) Checks if this participant can change the Maven Model from this Eclipse project configuration
void	addRestrictedPackaging(String packaging) Adds a Maven packaging to the set of restricted, compatible packagings for this converter.
abstract void	convert(org.eclipse.core.resources.IProject project, org.apache.maven.model.Model model, org.eclipse.core.runtime.IProgressMonitor monitor) Converts existing Eclipse project configuration to Maven model
String	getId()
String	getName()
String[]	getPrecedingConverterIds() Returns the ids of all AbstractProjectConversionParticipants this instance must run after.
Set<String>	getRestrictedPackagings() Returns all the Maven packagings this conversion participant is restricted to.
String[]	getSucceedingConverterIds() Returns the ids of all AbstractProjectConversionParticipants this instance must run before.
boolean	isPackagingCompatible(String packaging) Checks if this conversion participant allows the given Maven packaging to be converted : If there are no packaging restrictions or the packaging restrictions contain this packaging, then it's considered compatible.
void	setInitializationData(org.eclipse.core.runtime.IConfigurationElement config, String propertyName, Object data)
protected String[]	split(String str) Split a String using the comma delimiter, ignore whitespace.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_ID

public static final String ATTR_ID

See Also:

Constant Field Values

ATTR_NAME

public static final String ATTR_NAME

See Also:

Constant Field Values

ATTR_AFTER

public static final String ATTR_AFTER

See Also:

Constant Field Values

ATTR_BEFORE

public static final String ATTR_BEFORE

See Also:

Constant Field Values

restrictedPackagings

protected Set<String> restrictedPackagings

Constructor Detail

AbstractProjectConversionParticipant

public AbstractProjectConversionParticipant()

Method Detail

getName

public String getName()

getId

public String getId()

setInitializationData

public void setInitializationData(org.eclipse.core.runtime.IConfigurationElement config,
                                  String propertyName,
                                  Object data)

Specified by:

setInitializationData in interface org.eclipse.core.runtime.IExecutableExtension

split

protected String[] split(String str)

Split a String using the comma delimiter, ignore whitespace.

accept

public abstract boolean accept(org.eclipse.core.resources.IProject project)
                        throws org.eclipse.core.runtime.CoreException

Checks if this participant can change the Maven Model from this Eclipse project configuration

Throws:

org.eclipse.core.runtime.CoreException

convert

public abstract void convert(org.eclipse.core.resources.IProject project,
                             org.apache.maven.model.Model model,
                             org.eclipse.core.runtime.IProgressMonitor monitor)
                      throws org.eclipse.core.runtime.CoreException

Converts existing Eclipse project configuration to Maven model

Throws:

org.eclipse.core.runtime.CoreException

toString

public String toString()

Overrides:

toString in class Object

getRestrictedPackagings

public Set<String> getRestrictedPackagings()

Returns all the Maven packagings this conversion participant is restricted to.

Returns:

an unmodifiable Set copy of Maven packagings, can be null.

Since:

1.3

isPackagingCompatible

public boolean isPackagingCompatible(String packaging)

Checks if this conversion participant allows the given Maven packaging to be converted :
If there are no packaging restrictions or the packaging restrictions contain this packaging, then it's considered compatible.

Parameters:

packaging - the Maven packaging to check

Returns:

true if the packaging is compatible with this conversion participant.

addRestrictedPackaging

public void addRestrictedPackaging(String packaging)

Adds a Maven packaging to the set of restricted, compatible packagings for this converter.

Parameters:

packaging - the compatible Maven packaging to add

getPrecedingConverterIds

public String[] getPrecedingConverterIds()

Returns the ids of all AbstractProjectConversionParticipants this instance must run after.

Since:

1.3

getSucceedingConverterIds

public String[] getSucceedingConverterIds()

Returns the ids of all AbstractProjectConversionParticipants this instance must run before.

Since:

1.3