org.apache.maven.dotnet.executable
Interface ExecutableCapability

All Known Subinterfaces:

CompilerCapability

public interface ExecutableCapability

Provides information about the capability of a specific executable or compiler plugin. The framework will match this capability to an ExecutableRequirement. The framework can then use the getPluginClassName method to instantiate an appropriate class that is capable of supporting the ExecutableRequirement. Executable capabilities are specified within the executable-plugins.xml file.

Author:

Shane Isbell

See Also:

ExecutableRequirement, CapabilityMatcher

Nested Class Summary

static class

ExecutableCapability.Factory Provides factory services for creating a default instance of the executable capability.

Method Summary

java.lang.String	getArchitecture() Returns the architecture that the executable is capable of supporting.
CommandCapability	getCommandCapability() Returns the command options that the executable is capable of supporting.
java.lang.String	getExecutable() Returns the executable as it is given on the commandline.
java.util.List<java.lang.String>	getFrameworkVersions() Returns a list of all .NET frameworks versions that the executable is capable of supporting.
java.lang.String	getIdentifier() Returns the ID for this capability.
java.lang.String	getNetDependencyId() Returns the net dependency id (within the net-dependencies.xml file).
java.lang.String	getOperatingSystem() Returns the operating system that the executable is capable of supporting.
java.lang.String	getPluginClassName() Returns the class name of the executable plugin that knows how to handle the execution request.
java.lang.String	getProfile() Returns the supported profile.
Vendor	getVendor() Returns the vendor capability of the executable: currently only - MS, MONO, DotGNU
void	setArchitecture(java.lang.String architecture) Sets the architecture that the executable is capable of supporting.
void	setCommandCapability(CommandCapability commandCapability) Sets the command options that the executable is capable of supporting.
void	setExecutable(java.lang.String executable) Sets the executable as it is given on the commandline.
void	setFrameworkVersions(java.util.List<java.lang.String> frameworkVersions) Sets a list of all .NET frameworks versions that the executable is capable of supporting.
void	setIdentifier(java.lang.String identifier) Sets the ID for this capability.
void	setNetDependencyId(java.lang.String netDependencyId) Sets the net dependency id.
void	setOperatingSystem(java.lang.String operatingSystem) Sets the operating system that the executable is capable of supporting.
void	setPluginClassName(java.lang.String pluginClassName) Sets the class name of the executable plugin that knows how to handle the execution request.
void	setProfile(java.lang.String profile) Sets the supported profile.
void	setVendor(Vendor vendor) Sets the vendor capability of the executable: currently only - MS, MONO, DotGNU

Method Detail

getCommandCapability

CommandCapability getCommandCapability()

Returns the command options that the executable is capable of supporting.

Returns:

the command capability that the executable is capable of supporting. This capability is used to determine the command line parameters that the executable supports.

setCommandCapability

void setCommandCapability(CommandCapability commandCapability)

Sets the command options that the executable is capable of supporting.

Parameters:

commandCapability - the command capability, which is used to determine the command line parameters that the executable supports.

getIdentifier

java.lang.String getIdentifier()

Returns the ID for this capability.

Returns:

the ID for this capability

setIdentifier

void setIdentifier(java.lang.String identifier)

Sets the ID for this capability.

Parameters:

identifier - the ID of the capability

getVendor

Vendor getVendor()

Returns the vendor capability of the executable: currently only - MS, MONO, DotGNU

Returns:

the vendor capability of the executable

setVendor

void setVendor(Vendor vendor)

Sets the vendor capability of the executable: currently only - MS, MONO, DotGNU

Parameters:

vendor -

getProfile

java.lang.String getProfile()

Returns the supported profile. A profile is used to differentiate a capability beyond the standard vendor/OS/profile/frameworkVersion parameters.

Returns:

the supported profile

setProfile

void setProfile(java.lang.String profile)

Sets the supported profile. A profile is used to differentiate a capability beyond the standard vendor/OS/profile/frameworkVersion parameters.

Parameters:

profile - the profile of the executable.

getOperatingSystem

java.lang.String getOperatingSystem()

Returns the operating system that the executable is capable of supporting.

Returns:

the operating system that the executable is capable of supporting

setOperatingSystem

void setOperatingSystem(java.lang.String operatingSystem)

Sets the operating system that the executable is capable of supporting.

Parameters:

operatingSystem -

getArchitecture

java.lang.String getArchitecture()

Returns the architecture that the executable is capable of supporting.

Returns:

the architecture that the executable is capable of supporting

setArchitecture

void setArchitecture(java.lang.String architecture)

Sets the architecture that the executable is capable of supporting.

Parameters:

architecture - the architecture that the executable is capable of supporting

getFrameworkVersions

java.util.List<java.lang.String> getFrameworkVersions()

Returns a list of all .NET frameworks versions that the executable is capable of supporting.

Returns:

a list of all .NET frameworks versions that the executable is capable of supporting

setFrameworkVersions

void setFrameworkVersions(java.util.List<java.lang.String> frameworkVersions)

Sets a list of all .NET frameworks versions that the executable is capable of supporting.

Parameters:

frameworkVersions - a list of all .NET frameworks versions that the executable is capable of supporting

getExecutable

java.lang.String getExecutable()

Returns the executable as it is given on the commandline.

Returns:

the executable as it is given on the commandline

setExecutable

void setExecutable(java.lang.String executable)

Sets the executable as it is given on the commandline.

Parameters:

executable - the executable as it is given on the commandline

getPluginClassName

java.lang.String getPluginClassName()

Returns the class name of the executable plugin that knows how to handle the execution request.

Returns:

the class name of the executable plugin that knows how to handle the execution request

setPluginClassName

void setPluginClassName(java.lang.String pluginClassName)

Sets the class name of the executable plugin that knows how to handle the execution request.

Parameters:

pluginClassName - the class name of the executable plugin that knows how to handle the execution request

getNetDependencyId

java.lang.String getNetDependencyId()

Returns the net dependency id (within the net-dependencies.xml file).

Returns:

the net dependency id

setNetDependencyId

void setNetDependencyId(java.lang.String netDependencyId)

Sets the net dependency id.

Parameters:

netDependencyId -