ExecutionScriptConfiguration

@RMIWrap(ExecutionScriptConfiguration.ConfigurationRMIWrapper.class)

public final class ExecutionScriptConfiguration

saker.build.runtime.params.ExecutionScriptConfiguration

java.lang.Object

Configuration class for specifying the script language, options, and classpath information for a build execution.

An instance of this class can be created via the provided builder.

Clients can configure the how the script files should be handled by the build system based on its file path. The configuration uses wildcard paths to determine the correct scripting options and script language to use for a file.

If the specified wildcard paths are ambiguous, then the first added configuration will be used for a given path. (Ambiguity can happen if multiple wildcard paths can match a specific path.)

Users can specify an arbitrary string key-value map to pass to the scripting language parser, and the language to use for the given file.

Nested types

public static final class	Builder Builder class for ExecutionScriptConfiguration.
public static final class	ScriptOptionsConfig An options configuration specifying the parsing options and the location of the scripting language parser.
public static final class	ScriptProviderLocation Class holding information about how a scripting language provider should be retrieved.

Methods

public static Builder	builder() Creates a new empty builder.
public static Builder	builder(ExecutionScriptConfiguration config) Creates a new builder and initializes it with the specified configuration.
public static ExecutionScriptConfiguration	empty() Gets an empty script configuration.
public boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
public Map<WildcardPath, ? extends ScriptOptionsConfig>	getConfigurations() Gets the script configurations mapped to their wildcard paths.
public static ExecutionScriptConfiguration	getDefault() Gets the default script configuration which uses the built-in scripting language.
public static ScriptAccessProvider	getScriptAccessorProvider(SakerEnvironment environment, ScriptProviderLocation providerlocation) Retrieves the script language provider specified by the given provider location argument and uses the specified environment to manage the class loading.
public ScriptOptionsConfig	getScriptOptionsConfig(SakerPath scriptpath) Gets the script options configuration for the given script path.
public ScriptParsingOptions	getScriptParsingOptions(SakerPath scriptpath) Creates a script parsing options for a script path if it was configured.
public Set<? extends ScriptProviderLocation>	getScriptProviderLocations() Gets the script provider locations which are used in this script configuration.
public int	hashCode() Returns a hash code value for the object.
public String	toString() Returns a string representation of the object.

Inherited methods
From: Object clone, finalize, getClass, notify, notifyAll, wait, wait, wait

public static Builder builder()

Creates a new empty builder.

The builder doesn't contain any configuration, not even for the built-in scripting language.

The created builder.

public static Builder builder(ExecutionScriptConfiguration config)

Creates a new builder and initializes it with the specified configuration.

configThe configuration.

The created builder.

public static ExecutionScriptConfiguration empty()

Gets an empty script configuration.

The resulting configuration is empty, no scripting languages are available in it. Any build execution started with it most likely won't be able to parse build scripts.

An empty configuration.

public boolean equals(Object obj)

Overridden from: Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

objthe reference object with which to compare.

true if this object is the same as the obj argument; false otherwise.

Object.hashCode()

HashMap

public Map<WildcardPath, ? extends ScriptOptionsConfig> getConfigurations()

Gets the script configurations mapped to their wildcard paths.

The configurations.

public static ExecutionScriptConfiguration getDefault()

Gets the default script configuration which uses the built-in scripting language.

The default configuration uses the built-in scripting langauge for every script file that ends with the extension ".build" (case sensitive).

The returned configuration is a singleton instance.

The default script configuration.

ScriptProviderLocation.getBuiltin()

public static ScriptAccessProvider getScriptAccessorProvider(SakerEnvironment environment, ScriptProviderLocation providerlocation) throws Exception

Retrieves the script language provider specified by the given provider location argument and uses the specified environment to manage the class loading.

This method will use the caching facility of the given environment to load the classes specified by the location argument. The class path location will be loaded, and its lifecycle will be automatically managed by the argument environment. The appropriate ScriptAccessProvider instance will be returned.

environmentThe environment to load the classes with.

providerlocationThe location of the scripting language provider.

The loaded scripting language provider.

ExceptionIf for any reason the loading of the language failed. (Usually I/O errors or misconfigurations.)

public ScriptOptionsConfig getScriptOptionsConfig(SakerPath scriptpath) throws InvalidPathFormatException

Gets the script options configuration for the given script path.

scriptpathThe script path.

The script options configuration or null if no configuration was defined for the specified path.

InvalidPathFormatExceptionIf the path is not absolute.

public ScriptParsingOptions getScriptParsingOptions(SakerPath scriptpath) throws InvalidPathFormatException

Creates a script parsing options for a script path if it was configured.

scriptpathThe script path.

The script parsing options to use to parse the script or null if no configuration is set for the path.

InvalidPathFormatExceptionIf the path is not absolute.

public Set<? extends ScriptProviderLocation> getScriptProviderLocations()

Gets the script provider locations which are used in this script configuration.

The script provider locations.

public int hashCode()

Overridden from: Object

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the Object.equals(Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

a hash code value for this object.

Object.equals(Object)

System.identityHashCode(Object)

public String toString()

Overridden from: Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())

a string representation of the object.