io.sarl.apputils.eclipseextensions.sreprovider
Interface ISREInstall
All Superinterfaces:
java.lang.Cloneable
interface ISREInstall
implements java.lang.Cloneable
Represents a particular installation of a SARL runtime environment (SRE). A SRE instance holds all parameters specific to a SRE installation. SRE instances can be created and configured dynamically at run-time. This is typically done by the user interactively in the UI.
Maven Group Identifier:
io.sarl.apputils
Maven Artifact Identifier:
eclipseextensions
Since:
0.15
Property Summary
Modifier and type Property and description
java.util.Map<K,V> availableCommandLineOptions
Replies the available command line options for this SRE.
java.lang.String bootstrap
Returns the fully qualified name of the SRE bootstrap associated to this SRE.
java.util.List<E> classPathEntries
Returns the library locations of this ISREInstall.
java.lang.String id
Returns the id for this SRE.
java.lang.String jVMArguments
Replies the arguments to pass to the virtual machine as VM arguments for this SRE.
java.lang.String location
Returns the location of this runtime environment.
java.lang.String mainClass
Returns the fully qualified name of the main class for launching the runtime environment.
java.lang.String maximalSARLVersion
Returns the maximal version number of the SARL specification that is supported by the SRE.
java.lang.String minimalSARLVersion
Returns the minimal version number of the SARL specification that is supported by the SRE.
java.lang.String name
Returns the display name of this SRE.
java.lang.String nameNoDefault
Returns the display name of this SRE without considering to reply a default value for the name.
boolean notify
Replies if this SRE should fire property change notifications.
org.eclipse.core.runtime.IPath preferredClassPathContainerPath
Replies the path o the preferred container.
java.lang.String sREArguments
Replies the arguments to pass to the SRE instance.
org.eclipse.core.runtime.IStatus validity
Validate the SRE.
java.util.Map<K,V> vMSpecificAttributesMap
Replies the Map that contains String name/value pairs that represent VM-specific attributes for this SRE.
Field Summary
Modifier and type Field and description
static val int CODE_GENERAL
Error code for the status that corresponds to an invalid state of the ISREInstall.
static val int CODE_LIBRARY_LOCATION
Error code related to the library locations.
static val int CODE_MAIN_CLASS
Error code related to the main class name.
static val int CODE_NAME
Error code related to the name.
static val int CODE_SARL_VERSION
Error code related to the required SARL version.
static val int CODE_SOURCE
Error code related to the source file.
Action Summary
Modifier and type Action and description
abstract ISREInstall clone
Clone this SRE.
abstract ISREInstall copy(String)
Copy this SRE.
abstract void getAsXML(Document,Element)
Replies the XML representation of this SRE installation.
abstract java.util.Map<K,V> getAvailableCommandLineOptions
Replies the available command line options for this SRE.
abstract java.lang.String getBootstrap
Returns the fully qualified name of the SRE bootstrap associated to this SRE.
abstract java.util.List<E> getClassPathEntries
Returns the library locations of this ISREInstall.
abstract java.lang.String getId
Returns the id for this SRE.
abstract java.lang.String getJVMArguments
Replies the arguments to pass to the virtual machine as VM arguments for this SRE.
abstract java.lang.String getLocation
Returns the location of this runtime environment.
abstract java.lang.String getMainClass
Returns the fully qualified name of the main class for launching the runtime environment.
abstract java.lang.String getMaximalSARLVersion
Returns the maximal version number of the SARL specification that is supported by the SRE.
abstract java.lang.String getMinimalSARLVersion
Returns the minimal version number of the SARL specification that is supported by the SRE.
abstract java.lang.String getName
Returns the display name of this SRE.
abstract java.lang.String getNameNoDefault
Returns the display name of this SRE without considering to reply a default value for the name.
abstract boolean getNotify
Replies if this SRE should fire property change notifications.
abstract org.eclipse.core.runtime.IPath getPreferredClassPathContainerPath
Replies the path o the preferred container.
abstract java.lang.String getSREArguments
Replies the arguments to pass to the SRE instance.
default org.eclipse.core.runtime.IStatus getValidity
Validate the SRE.
abstract org.eclipse.core.runtime.IStatus getValidity(int)
Validate the SRE.
abstract java.util.Map<K,V> getVMSpecificAttributesMap
Replies the Map that contains String name/value pairs that represent VM-specific attributes for this SRE.
abstract org.eclipse.core.runtime.IStatus revalidate
Force the computation of the installation validity.
abstract void setBootstrap(String)
Change the fully qualified name of the bootstrap.
default void setClassPathEntries(Iterable<T>)
Change the library locations of this ISREInstall.
abstract void setClassPathEntries(List<E>)
Change the library locations of this ISREInstall.
abstract void setFromXML(Element)
Set this SRE installation from the given XML representation.
abstract void setMainClass(String)
Change the fully qualified name of the main class for launching the runtime environment.
abstract void setMaximalSARLVersion(String)
Change the maximal version number of the SARL specification that is supported by the SRE.
abstract void setMinimalSARLVersion(String)
Change the minimal version number of the SARL specification that is supported by the SRE.
abstract void setName(String)
Change the display name of this SRE.
abstract void setNotify(boolean)
Whether this SRE should fire property change notifications.
abstract void setVMSpecificAttributesMap(Map<K,V>)
Change the Map that contains String name/value pairs that represent VM-specific attributes for this SRE.
Property Details
availableCommandLineOptions
val availableCommandLineOptions : java.util.Map<K,V>
Replies the available command line options for this SRE.

The replied map describes the CLI options to use in specific use cases. The keys are defined in SREConstants, where the key names are started by MANIFEST_CLI_.

This property is an alias for the action: getAvailableCommandLineOptions

Returns:
the program arguments to pass to the SRE (not the Java virtual machine).
See:
getJVMArguments
bootstrap
var bootstrap : java.lang.String
Returns the fully qualified name of the SRE bootstrap associated to this SRE.

This property is an alias for the action: getBootstrap

Returns:
the fully qualified name of the bootstrap, or null if none.
classPathEntries
var classPathEntries : java.util.List<E>
Returns the library locations of this ISREInstall.

This property is an alias for the action: getClassPathEntries

Returns:
The library locations of this ISREInstall. Must not return null .
id
val id : java.lang.String
Returns the id for this SRE. The SRE id is not intended to be presented to users.

This property is an alias for the action: getId

Returns:
the SRE identifier. Must not return null .
jVMArguments
val jVMArguments : java.lang.String
Replies the arguments to pass to the virtual machine as VM arguments for this SRE. The replied arguments could contain the main class replied by getMainClass().

This property is an alias for the action: getJVMArguments

Returns:
the VM arguments to pass to the virtual machine for this SRE.
See:
getSREArguments
location
val location : java.lang.String
Returns the location of this runtime environment. The semantic of the location depends on the type of the ISREInstall.

This property is an alias for the action: getLocation

Returns:
the location of the runtime environment. Must be never null .
mainClass
var mainClass : java.lang.String
Returns the fully qualified name of the main class for launching the runtime environment.

This property is an alias for the action: getMainClass

Returns:
the fully qualified name of the main class of the SRE. Must not return null .
maximalSARLVersion
var maximalSARLVersion : java.lang.String
Returns the maximal version number of the SARL specification that is supported by the SRE.

This property is an alias for the action: getMaximalSARLVersion

Returns:
the maximal version number. Must not return null .
minimalSARLVersion
var minimalSARLVersion : java.lang.String
Returns the minimal version number of the SARL specification that is supported by the SRE.

This property is an alias for the action: getMinimalSARLVersion

Returns:
the minimal version number. Must not return null .
name
var name : java.lang.String
Returns the display name of this SRE. The SRE name is intended to be presented to users.

This function replies the name of the SRE, or a default value if there is no name replied by getNameNoDefault(). Consequently, this function never replies null.

This property is an alias for the action: getName

Returns:
the display name of this SRE. May not return null .
See:
getNameNoDefault
nameNoDefault
val nameNoDefault : java.lang.String
Returns the display name of this SRE without considering to reply a default value for the name.

This function replies the name of the SRE but never any default value replied by getName(). Consequently, this function could reply null.

This property is an alias for the action: getNameNoDefault

Returns:
the display name of this SRE. May return null .
See:
getName
notify
var notify : boolean
Replies if this SRE should fire property change notifications.

This property is an alias for the action: getNotify

Returns:
if this SRE should fire property change notifications.
preferredClassPathContainerPath
val preferredClassPathContainerPath : org.eclipse.core.runtime.IPath
Replies the path o the preferred container.

This property is an alias for the action: getPreferredClassPathContainerPath

Returns:
the preferred container's path, or null .
Since:
0.7
sREArguments
val sREArguments : java.lang.String
Replies the arguments to pass to the SRE instance.

This property is an alias for the action: getSREArguments

Returns:
the arguments for the SRE.
validity
val validity : org.eclipse.core.runtime.IStatus
Validate the SRE. The validation does not ignore any invalidity cause.

This property is an alias for the action: getValidity

Returns:
the validation status.
See:
getValidity(int)
vMSpecificAttributesMap
var vMSpecificAttributesMap : java.util.Map<K,V>
Replies the Map that contains String name/value pairs that represent VM-specific attributes for this SRE.

This property is an alias for the action: getVMSpecificAttributesMap

Returns:
the VM-specific attributes.
Field Details
CODE_GENERAL
static val CODE_GENERAL : int = 1
Error code for the status that corresponds to an invalid state of the ISREInstall.
CODE_LIBRARY_LOCATION
static val CODE_LIBRARY_LOCATION : int = 2
Error code related to the library locations.
CODE_MAIN_CLASS
static val CODE_MAIN_CLASS : int = 8
Error code related to the main class name.
CODE_NAME
static val CODE_NAME : int = 16
Error code related to the name.
CODE_SARL_VERSION
static val CODE_SARL_VERSION : int = 4
Error code related to the required SARL version.
CODE_SOURCE
static val CODE_SOURCE : int = 32
Error code related to the source file.
Action Details
clone
def clone : ISREInstall
Clone this SRE. The clone has the same Id as the cloned object.
Returns:
the clone.
See:
copy(String)
copy(String)
def copy(String) : ISREInstall
Copy this SRE. The copy has not the same Id as the copied object.
Parameters:
id - the identifier for the copy.
Returns:
the copy.
See:
clone
getAsXML(Document,Element)
def getAsXML(Document,Element)
 throws java.io.IOException
Replies the XML representation of this SRE installation. The XML string could be used to save this SRE installation in the preferences.
Parameters:
document - the XML document is which the XML element is located.
element - the XML node that must be the representation of this SRE installation.
Throws exception:
  • java.io.IOException: if cannot create the XML representation.
getAvailableCommandLineOptions
def getAvailableCommandLineOptions : java.util.Map<K,V>
Replies the available command line options for this SRE.

The replied map describes the CLI options to use in specific use cases. The keys are defined in SREConstants, where the key names are started by MANIFEST_CLI_.
Returns:
the program arguments to pass to the SRE (not the Java virtual machine).
See:
getJVMArguments
getBootstrap
def getBootstrap : java.lang.String
Returns the fully qualified name of the SRE bootstrap associated to this SRE.
Returns:
the fully qualified name of the bootstrap, or null if none.
getClassPathEntries
def getClassPathEntries : java.util.List<E>
Returns the library locations of this ISREInstall.
Returns:
The library locations of this ISREInstall. Must not return null .
getId
def getId : java.lang.String
Returns the id for this SRE. The SRE id is not intended to be presented to users.
Returns:
the SRE identifier. Must not return null .
getJVMArguments
def getJVMArguments : java.lang.String
Replies the arguments to pass to the virtual machine as VM arguments for this SRE. The replied arguments could contain the main class replied by getMainClass().
Returns:
the VM arguments to pass to the virtual machine for this SRE.
See:
getSREArguments
getLocation
def getLocation : java.lang.String
Returns the location of this runtime environment. The semantic of the location depends on the type of the ISREInstall.
Returns:
the location of the runtime environment. Must be never null .
getMainClass
def getMainClass : java.lang.String
Returns the fully qualified name of the main class for launching the runtime environment.
Returns:
the fully qualified name of the main class of the SRE. Must not return null .
getMaximalSARLVersion
def getMaximalSARLVersion : java.lang.String
Returns the maximal version number of the SARL specification that is supported by the SRE.
Returns:
the maximal version number. Must not return null .
getMinimalSARLVersion
def getMinimalSARLVersion : java.lang.String
Returns the minimal version number of the SARL specification that is supported by the SRE.
Returns:
the minimal version number. Must not return null .
getName
def getName : java.lang.String
Returns the display name of this SRE. The SRE name is intended to be presented to users.

This function replies the name of the SRE, or a default value if there is no name replied by getNameNoDefault(). Consequently, this function never replies null.
Returns:
the display name of this SRE. May not return null .
See:
getNameNoDefault
getNameNoDefault
def getNameNoDefault : java.lang.String
Returns the display name of this SRE without considering to reply a default value for the name.

This function replies the name of the SRE but never any default value replied by getName(). Consequently, this function could reply null.
Returns:
the display name of this SRE. May return null .
See:
getName
getNotify
def getNotify : boolean
Replies if this SRE should fire property change notifications.
Returns:
if this SRE should fire property change notifications.
getPreferredClassPathContainerPath
def getPreferredClassPathContainerPath : org.eclipse.core.runtime.IPath
Replies the path o the preferred container.
Returns:
the preferred container's path, or null .
Since:
0.7
getSREArguments
def getSREArguments : java.lang.String
Replies the arguments to pass to the SRE instance.
Returns:
the arguments for the SRE.
getValidity
def getValidity : org.eclipse.core.runtime.IStatus
Validate the SRE. The validation does not ignore any invalidity cause.
Returns:
the validation status.
See:
getValidity(int)
getValidity(int)
def getValidity(int) : org.eclipse.core.runtime.IStatus
Validate the SRE. The validation does not ignore any invalidity cause.
Parameters:
ignoreCauses - a set of bits that indicates the invalidity causes to ignore.
Returns:
the validation status.
See:
getValidity
getVMSpecificAttributesMap
def getVMSpecificAttributesMap : java.util.Map<K,V>
Replies the Map that contains String name/value pairs that represent VM-specific attributes for this SRE.
Returns:
the VM-specific attributes.
revalidate
def revalidate : org.eclipse.core.runtime.IStatus
Force the computation of the installation validity.
Returns:
the validity status.
setBootstrap(String)
def setBootstrap(String)
Change the fully qualified name of the bootstrap.
Parameters:
bootstrap - the fully qualified name of the bootstrap, or null.
setClassPathEntries(Iterable<T>)
def setClassPathEntries(Iterable<T>)
Change the library locations of this ISREInstall.
Parameters:
libraries - The library locations of this ISREInstall. Must not be null.
setClassPathEntries(List<E>)
def setClassPathEntries(List<E>)
Change the library locations of this ISREInstall.
Parameters:
libraries - The library locations of this ISREInstall. Must not be null.
setFromXML(Element)
def setFromXML(Element)
 throws java.io.IOException
Set this SRE installation from the given XML representation.
Parameters:
element - the XML node that must be the representation of this SRE installation.
Throws exception:
  • java.io.IOException: if cannot read the XML representation.
setMainClass(String)
def setMainClass(String)
Change the fully qualified name of the main class for launching the runtime environment.
Parameters:
mainClass - the fully qualified name of the main class of the SRE. Must not be null.
setMaximalSARLVersion(String)
def setMaximalSARLVersion(String)
Change the maximal version number of the SARL specification that is supported by the SRE.
Parameters:
version - the maximal version number. Must not be null.
setMinimalSARLVersion(String)
def setMinimalSARLVersion(String)
Change the minimal version number of the SARL specification that is supported by the SRE.
Parameters:
version - the minimal version number. Must not be null.
setName(String)
def setName(String)
Change the display name of this SRE. The SRE name is intended to be presented to users.
Parameters:
name - the display name of this SRE. May be null.
setNotify(boolean)
def setNotify(boolean)
Whether this SRE should fire property change notifications.
Parameters:
notify - if this SRE should fire property change notifications.
setVMSpecificAttributesMap(Map<K,V>)
def setVMSpecificAttributesMap(Map<K,V>)
Change the Map that contains String name/value pairs that represent VM-specific attributes for this SRE.
Parameters:
attributes - the VM-specific attributes.