io.sarl.apputils.eclipseextensions.projectconfig
Interface ProjectConfigurationFragment
interface ProjectConfigurationFragment
Fragment of the configuration for a SARL project.

This fragment may be used to add specific configuration elements to a SARL project.
Maven Group Identifier:
io.sarl.apputils
Maven Artifact Identifier:
eclipseextensions
Since:
0.15
Property Summary
Modifier and type Property and description
java.lang.String id
Replies the identifier for this project fragment
java.lang.String label
Replies the label that is briefly describing this project configuration fragment.
Action Summary
Modifier and type Action and description
abstract java.util.List<E> getBinaryClassPathEntries(IPath)
Replies the default binary entries or libraries for the project configurator.
abstract java.util.List<E> getDefaultSourceClassPathEntries(IPath)
Replies the default source entries for the project configurator.
abstract java.lang.String getId
Replies the identifier for this project fragment
abstract java.lang.String getLabel
Replies the label that is briefly describing this project configuration fragment.
abstract boolean isActiveByDefault
Replies if the contribution of this fragment should be active by default when opening the project configurator.
abstract void unconfigure(IProject,IProgressMonitor,List<E>)
Unconfigure the given project.
abstract void updateNatures(IProject,IProgressMonitor)
Update the natures of the given project.
abstract void updateSourceFolders(IProject,boolean,IProgressMonitor,SortedSet<E>,SortedSet<E>,SortedSet<E>,SortedSet<E>)
Update the lists of source folders.
abstract void updateSpecificConfiguration(IProject,IProgressMonitor,IPath,IPath)
Update the specific configuration of the project.
Property Details
id
val id : java.lang.String
Replies the identifier for this project fragment

This property is an alias for the action: getId

Returns:
the identifier, never null .
label
val label : java.lang.String
Replies the label that is briefly describing this project configuration fragment.

This property is an alias for the action: getLabel

Returns:
the label, never null .
Action Details
getBinaryClassPathEntries(IPath)
def getBinaryClassPathEntries(IPath) : java.util.List<E>
Replies the default binary entries or libraries for the project configurator.
Parameters:
projectFolder - the folder of the project.
Returns:
the classpath entries.
getDefaultSourceClassPathEntries(IPath)
def getDefaultSourceClassPathEntries(IPath) : java.util.List<E>
Replies the default source entries for the project configurator.
Parameters:
projectFolder - the folder of the project.
Returns:
the classpath entries.
getId
def getId : java.lang.String
Replies the identifier for this project fragment
Returns:
the identifier, never null .
getLabel
def getLabel : java.lang.String
Replies the label that is briefly describing this project configuration fragment.
Returns:
the label, never null .
isActiveByDefault
def isActiveByDefault : boolean
Replies if the contribution of this fragment should be active by default when opening the project configurator.
Returns:
true if the fragment is active by default in the configurator interface.
unconfigure(IProject,IProgressMonitor,List<E>)
def unconfigure(IProject,IProgressMonitor,List<E>)
Unconfigure the given project.
Parameters:
project - the project to update.
monitor - the progress monitor.
natures - the natures to associate to the project after unconfiguring it.
updateNatures(IProject,IProgressMonitor)
def updateNatures(IProject,IProgressMonitor)
Update the natures of the given project.
Parameters:
project - the project to update.
monitor - the progress monitor.
updateSourceFolders(IProject,boolean,IProgressMonitor,SortedSet<E>,SortedSet<E>,SortedSet<E>,SortedSet<E>)
def updateSourceFolders(IProject,boolean,IProgressMonitor,SortedSet<E>,SortedSet<E>,SortedSet<E>,SortedSet<E>)
 throws org.eclipse.core.runtime.CoreException
Update the lists of source folders.
Parameters:
project - the project to update.
createFolders - indicates if the source folder must be created on the hard-disk.
monitor - the progress monitor.
sourcePaths - the list of the regular source folders.
testSourcePaths - the list of the test source folders.
generationPaths - the list of the regular source folders in which generated code is written.
testGenerationPaths - the list of the test source folders in which generated code is written.
Throws exception:
  • org.eclipse.core.runtime.CoreException: if there is an error related to one of the source folders.
updateSpecificConfiguration(IProject,IProgressMonitor,IPath,IPath)
def updateSpecificConfiguration(IProject,IProgressMonitor,IPath,IPath)
Update the specific configuration of the project.
Parameters:
project - the project to update.
monitor - the progress monitor.
generationFolderPath - the folder in which the generated regular code is written.
testGenerationFolderPath - the folder in which the generated test code is written.