Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- add(String) - Method in class org.savantbuild.runtime.Switches
-
Adds a switch that has no value (boolean).
- add(String, String) - Method in class org.savantbuild.runtime.Switches
-
Adds a switch with the given value.
- add(String, Publication) - Method in class org.savantbuild.domain.Publications
-
Adds the given Publication to the given group.
- allPublications() - Method in class org.savantbuild.domain.Publications
- artifactGraph - Variable in class org.savantbuild.domain.Project
- attributesValid(Map<String, Object>, Collection<String>, Collection<String>, Map<String, Class<?>>) - Static method in class org.savantbuild.parser.groovy.GroovyTools
-
Ensures that the attributes are valid.
B
- BaseGroovyPlugin - Class in org.savantbuild.plugin.groovy
-
Abstract base class for plugins.
- BaseGroovyPlugin(Project, RuntimeConfiguration, Output) - Constructor for class org.savantbuild.plugin.groovy.BaseGroovyPlugin
- booleanSwitches - Variable in class org.savantbuild.runtime.Switches
- build(Project) - Method in class org.savantbuild.parser.DefaultTargetGraphBuilder
- build(Project) - Method in interface org.savantbuild.parser.TargetGraphBuilder
-
Builds a graph of target dependencies for the given project.
- BuildFailureException - Exception in org.savantbuild.runtime
-
Thrown from the build script when the build fails.
- BuildFailureException() - Constructor for exception org.savantbuild.runtime.BuildFailureException
- BuildFailureException(String) - Constructor for exception org.savantbuild.runtime.BuildFailureException
- BuildFailureException(String, Throwable) - Constructor for exception org.savantbuild.runtime.BuildFailureException
- BuildFileParser - Interface in org.savantbuild.parser
-
Parses the build file into the domain objects.
- BuildRunException - Exception in org.savantbuild.runtime
-
Thrown when Savant fails while running the build.
- BuildRunException(String) - Constructor for exception org.savantbuild.runtime.BuildRunException
- BuildRunner - Interface in org.savantbuild.runtime
-
Runs the build starting from a build file.
C
- cache(Map<String, Object>) - Method in class org.savantbuild.parser.groovy.WorkflowDelegate.ProcessDelegate
-
Adds a
CacheProcessto the workflow that uses the given attributes. - colorizeOutput - Variable in class org.savantbuild.runtime.RuntimeConfiguration
-
Determines if the output should be colorized.
D
- debug - Variable in class org.savantbuild.runtime.RuntimeConfiguration
-
Determines if debug output is enabled.
- DEBUG_SWITCH - Static variable in class org.savantbuild.runtime.RuntimeConfiguration
-
Define the debug switch.
- DefaultBuildRunner - Class in org.savantbuild.runtime
-
Default build runner.
- DefaultBuildRunner(Output, BuildFileParser, ProjectRunner) - Constructor for class org.savantbuild.runtime.DefaultBuildRunner
- defaultMavenDir - Static variable in class org.savantbuild.parser.groovy.WorkflowDelegate
- DefaultPluginLoader - Class in org.savantbuild.plugin
-
Default plugin loader that uses the Savant dependency service and a URLClassLoader to load the plugin.
- DefaultPluginLoader(Project, RuntimeConfiguration, Output) - Constructor for class org.savantbuild.plugin.DefaultPluginLoader
- DefaultProjectRunner - Class in org.savantbuild.runtime
-
Default project object runner.
- DefaultProjectRunner(Output) - Constructor for class org.savantbuild.runtime.DefaultProjectRunner
- DefaultRuntimeConfigurationParser - Class in org.savantbuild.runtime
-
Default implementation that uses a simple brute force approach for now.
- DefaultRuntimeConfigurationParser() - Constructor for class org.savantbuild.runtime.DefaultRuntimeConfigurationParser
- DefaultTargetGraphBuilder - Class in org.savantbuild.parser
-
Default target graph builder.
- DefaultTargetGraphBuilder() - Constructor for class org.savantbuild.parser.DefaultTargetGraphBuilder
- dependencies - Variable in class org.savantbuild.domain.Project
- dependencies - Variable in class org.savantbuild.domain.Target
- dependencies(Closure<?>) - Method in class org.savantbuild.parser.groovy.ProjectDelegate
-
Configures the project dependencies.
- DependenciesDelegate - Class in org.savantbuild.parser.groovy
-
Groovy delegate that defines the dependencies.
- DependenciesDelegate(Dependencies, Map<String, Version>) - Constructor for class org.savantbuild.parser.groovy.DependenciesDelegate
- dependency(Map<String, Object>) - Method in class org.savantbuild.parser.groovy.DependencyDelegate
-
Defines a dependency without exclusion by calling
DependencyDelegate.dependency(Map, Closure)with null for the closure. - dependency(Map<String, Object>, Closure<?>) - Method in class org.savantbuild.parser.groovy.DependencyDelegate
-
Defines a dependency.
- DependencyDelegate - Class in org.savantbuild.parser.groovy
-
Groovy delegate that defines the dependencies.
- DependencyDelegate(DependencyGroup, Map<String, Version>) - Constructor for class org.savantbuild.parser.groovy.DependencyDelegate
- dependencyService - Variable in class org.savantbuild.domain.Project
- description - Variable in class org.savantbuild.domain.Target
- directory - Variable in class org.savantbuild.domain.Project
E
- ENV - Variable in class org.savantbuild.parser.groovy.ProjectBuildFile
- equals(Object) - Method in class org.savantbuild.domain.Publications
- exclusion(Map<String, Object>) - Method in class org.savantbuild.parser.groovy.ExclusionDelegate
-
Defines am exclusion.
- ExclusionDelegate - Class in org.savantbuild.parser.groovy
-
Groovy delegate that defines the exclusions for a single dependency.
- ExclusionDelegate() - Constructor for class org.savantbuild.parser.groovy.ExclusionDelegate
F
- fail(String, Object...) - Method in class org.savantbuild.parser.groovy.ProjectBuildFile
-
Fails the build with the given message by throwing a
BuildFailureException. - fail(String, Object...) - Method in class org.savantbuild.plugin.groovy.BaseGroovyPlugin
-
Fails the build with the given message by throwing a
BuildFailureException. - fetch(Closure<?>) - Method in class org.savantbuild.parser.groovy.WorkflowDelegate
-
Configures the fetch workflow processes.
G
- getExclusions() - Method in class org.savantbuild.parser.groovy.ExclusionDelegate
- getProperty(String) - Method in class org.savantbuild.parser.groovy.GlobalConfiguration
- getProperty(String) - Method in class org.savantbuild.parser.groovy.ProjectBuildFile
- global - Variable in class org.savantbuild.parser.groovy.ProjectBuildFile
- GlobalConfiguration - Class in org.savantbuild.parser.groovy
-
This class loads an optional global configuration file named config.properties in the XDG config directory ($XDG_CONFIG_HOME/savant/ or ~/.config/savant/).
- GlobalConfiguration() - Constructor for class org.savantbuild.parser.groovy.GlobalConfiguration
- GRAPH_EDGE - Static variable in class org.savantbuild.domain.Project
- GroovyBuildFileParser - Class in org.savantbuild.parser.groovy
-
Parses the build file using a Groovy DSL.
- GroovyBuildFileParser(Output, TargetGraphBuilder) - Constructor for class org.savantbuild.parser.groovy.GroovyBuildFileParser
- GroovyTools - Class in org.savantbuild.parser.groovy
-
Groovy helpers.
- GroovyTools() - Constructor for class org.savantbuild.parser.groovy.GroovyTools
- group - Variable in class org.savantbuild.domain.Project
- group - Variable in class org.savantbuild.parser.groovy.PublicationsDelegate.PublicationGroupDelegate
- group(String) - Method in class org.savantbuild.domain.Publications
-
Null safe getter for a single group.
- group(Map<String, Object>, Closure<?>) - Method in class org.savantbuild.parser.groovy.DependenciesDelegate
-
Defines a group in the dependencies.
H
- has(String) - Method in class org.savantbuild.runtime.Switches
-
Returns whether or not the given switch was given by the user.
- hasAttributes(Map<String, Object>, Iterable<String>) - Static method in class org.savantbuild.parser.groovy.GroovyTools
-
Checks if the given attributes Map has all the given attribute names.
- hasAttributes(Map<String, Object>, String...) - Static method in class org.savantbuild.parser.groovy.GroovyTools
-
Checks if the given attributes Map has all the given attribute names.
- hasAttributeTypes(Map<String, Object>, Map<String, Class<?>>) - Static method in class org.savantbuild.parser.groovy.GroovyTools
-
Checks if the given attributes Map has the correct types.
- hashCode() - Method in class org.savantbuild.domain.Publications
- hasValue(String, String) - Method in class org.savantbuild.runtime.Switches
-
Returns whether or not the given switch has the given value.
- help - Variable in class org.savantbuild.runtime.RuntimeConfiguration
-
Determines if the user needs help.
I
- invocation - Variable in class org.savantbuild.domain.Target
- invokeMethod(String, Object) - Method in class org.savantbuild.parser.groovy.PublicationsDelegate
L
- licenses - Variable in class org.savantbuild.domain.Project
- listTargets - Variable in class org.savantbuild.runtime.RuntimeConfiguration
-
Determines if the targets in the project build file should be printed to the output.
- load(Artifact) - Method in class org.savantbuild.plugin.DefaultPluginLoader
-
Loads the plugin with the given dependency.
- load(Artifact) - Method in interface org.savantbuild.plugin.PluginLoader
-
Loads the plugin with the given dependency.
- loadConfiguration(ArtifactID, String) - Method in class org.savantbuild.plugin.groovy.BaseGroovyPlugin
-
Loads the plugin configuration file.
- loadPlugin(Map<String, Object>) - Method in class org.savantbuild.parser.groovy.ProjectBuildFile
-
Loads a plugin and returns a new instance of the Plugin class.
M
- main(String...) - Static method in class org.savantbuild.runtime.Main
-
THe main method.
- Main - Class in org.savantbuild.runtime
-
Main entry point for Savant CLI runtime.
- Main() - Constructor for class org.savantbuild.runtime.Main
- mapping - Variable in class org.savantbuild.parser.groovy.SemanticVersionDelegate
- mapping(Map<String, Object>) - Method in class org.savantbuild.parser.groovy.SemanticVersionDelegate
- maven(Map<String, Object>) - Method in class org.savantbuild.parser.groovy.WorkflowDelegate.ProcessDelegate
-
Adds a
MavenProcessto the workflow that uses the given attributes. - mavenCache(Map<String, Object>) - Method in class org.savantbuild.parser.groovy.WorkflowDelegate.ProcessDelegate
-
Adds a
CacheProcessto the workflow that handles Maven-sourced artifacts (mavenDir set, savantDir null).
N
- name - Variable in class org.savantbuild.domain.Project
- name - Variable in class org.savantbuild.domain.Target
O
- org.savantbuild.domain - package org.savantbuild.domain
- org.savantbuild.parser - package org.savantbuild.parser
- org.savantbuild.parser.groovy - package org.savantbuild.parser.groovy
- org.savantbuild.plugin - package org.savantbuild.plugin
- org.savantbuild.plugin.groovy - package org.savantbuild.plugin.groovy
- org.savantbuild.runtime - package org.savantbuild.runtime
- output - Variable in class org.savantbuild.domain.Project
- output - Variable in class org.savantbuild.parser.groovy.ProjectBuildFile
- output - Variable in class org.savantbuild.parser.groovy.ProjectDelegate
- output - Variable in class org.savantbuild.parser.groovy.WorkflowDelegate
- output - Variable in class org.savantbuild.parser.groovy.WorkflowDelegate.ProcessDelegate
- output - Variable in class org.savantbuild.plugin.groovy.BaseGroovyPlugin
P
- parse(String...) - Method in class org.savantbuild.runtime.DefaultRuntimeConfigurationParser
-
Parses the command-line arguments.
- parse(String...) - Method in interface org.savantbuild.runtime.RuntimeConfigurationParser
-
Parses the command-line arguments and builds a RuntimeConfiguration instance.
- parse(Path, RuntimeConfiguration) - Method in interface org.savantbuild.parser.BuildFileParser
-
Parses the given file and generates the Project object.
- parse(Path, RuntimeConfiguration) - Method in class org.savantbuild.parser.groovy.GroovyBuildFileParser
-
Executes the script using a GroovyClassLoader and the ProjectBuildFileMetaClass.
- ParseException - Exception in org.savantbuild.parser
-
Thrown when parsing fails for any reason.
- ParseException(String) - Constructor for exception org.savantbuild.parser.ParseException
- ParseException(String, Throwable) - Constructor for exception org.savantbuild.parser.ParseException
- Plugin - Interface in org.savantbuild.plugin
-
Defines a Plugin for the Savant build system.
- pluginConfigurationDirectory - Variable in class org.savantbuild.domain.Project
- PluginLoader - Interface in org.savantbuild.plugin
-
Defines the method used to load Plugins
- PluginLoadException - Exception in org.savantbuild.plugin
-
Thrown when plugin loading fails.
- PluginLoadException(String) - Constructor for exception org.savantbuild.plugin.PluginLoadException
- PluginLoadException(String, Throwable) - Constructor for exception org.savantbuild.plugin.PluginLoadException
- plugins - Variable in class org.savantbuild.domain.Project
- printCompatibilityError(CompatibilityException, Output) - Static method in class org.savantbuild.runtime.Main
- printHelp(Output) - Static method in class org.savantbuild.runtime.Main
- printVersion - Variable in class org.savantbuild.runtime.RuntimeConfiguration
-
Determines if the version should be displayed
- printVersion(Output) - Static method in class org.savantbuild.runtime.Main
- ProcessDelegate(Output, List<Process>) - Constructor for class org.savantbuild.parser.groovy.WorkflowDelegate.ProcessDelegate
- processes - Variable in class org.savantbuild.parser.groovy.WorkflowDelegate.ProcessDelegate
- project - Variable in class org.savantbuild.parser.groovy.ProjectBuildFile
- project - Variable in class org.savantbuild.parser.groovy.ProjectDelegate
- project - Variable in class org.savantbuild.parser.groovy.PublicationsDelegate.PublicationGroupDelegate
- project - Variable in class org.savantbuild.plugin.groovy.BaseGroovyPlugin
- project(Map<String, Object>, Closure<?>) - Method in class org.savantbuild.parser.groovy.ProjectBuildFile
-
Sets up the project information in the build file.
- Project - Class in org.savantbuild.domain
-
This class defines the project.
- Project(Path, Output) - Constructor for class org.savantbuild.domain.Project
- ProjectBuildFile - Class in org.savantbuild.parser.groovy
-
Base class from the project build file Groovy script.
- ProjectBuildFile() - Constructor for class org.savantbuild.parser.groovy.ProjectBuildFile
- ProjectDelegate - Class in org.savantbuild.parser.groovy
-
Groovy delegate that captures the Project configuration from the project build file.
- ProjectDelegate(Output, Project) - Constructor for class org.savantbuild.parser.groovy.ProjectDelegate
- projectDir - Static variable in class org.savantbuild.runtime.Main
- ProjectRunner - Interface in org.savantbuild.runtime
-
Runs the project's targets using the
Projectand the commands from the user. - properties - Variable in class org.savantbuild.parser.groovy.GlobalConfiguration
- publication(Map<String, Object>) - Method in class org.savantbuild.parser.groovy.PublicationsDelegate.PublicationGroupDelegate
-
Defines a publication.
- PublicationGroupDelegate(Project, Publications, String) - Constructor for class org.savantbuild.parser.groovy.PublicationsDelegate.PublicationGroupDelegate
- publicationGroups - Variable in class org.savantbuild.domain.Publications
- publications - Variable in class org.savantbuild.domain.Project
- publications - Variable in class org.savantbuild.parser.groovy.PublicationsDelegate.PublicationGroupDelegate
- publications(Closure<?>) - Method in class org.savantbuild.parser.groovy.ProjectDelegate
-
Configures the project publications.
- Publications - Class in org.savantbuild.domain
-
Models the publication set in the project build file.
- Publications() - Constructor for class org.savantbuild.domain.Publications
- PublicationsDelegate - Class in org.savantbuild.parser.groovy
-
Groovy delegate for defining publications.
- PublicationsDelegate(Project, Publications) - Constructor for class org.savantbuild.parser.groovy.PublicationsDelegate
- PublicationsDelegate.PublicationGroupDelegate - Class in org.savantbuild.parser.groovy
-
Delegate for a publication group.
- publish(Closure<?>) - Method in class org.savantbuild.parser.groovy.WorkflowDelegate
-
Configures the publish workflow processes.
- publishWorkflow - Variable in class org.savantbuild.domain.Project
- publishWorkflow(Closure<?>) - Method in class org.savantbuild.parser.groovy.ProjectDelegate
-
Configures the project publish workflow.
- putDefaults(Map<String, Object>, Map<String, Object>) - Static method in class org.savantbuild.parser.groovy.GroovyTools
-
Puts all the values from the defaults map into the main map if they are absent.
R
- rangeMapping - Variable in class org.savantbuild.parser.groovy.SemanticVersionDelegate
- rangeMapping(Map<String, Object>) - Method in class org.savantbuild.parser.groovy.SemanticVersionDelegate
- RESOLVE_CONFIGURATION - Static variable in class org.savantbuild.plugin.DefaultPluginLoader
- run(Path, RuntimeConfiguration) - Method in interface org.savantbuild.runtime.BuildRunner
-
Loads the given build file and executes the given targets in the build file.
- run(Path, RuntimeConfiguration) - Method in class org.savantbuild.runtime.DefaultBuildRunner
-
Loads the given build file and executes the given targets in the build file.
- run(Project, Iterable<String>) - Method in class org.savantbuild.runtime.DefaultProjectRunner
-
Runs the targets by finding each target and then performing a graph traversal of that targets dependencies.
- run(Project, Iterable<String>) - Method in interface org.savantbuild.runtime.ProjectRunner
-
Executes the given targets on the given project.
- runtimeConfiguration - Variable in class org.savantbuild.parser.groovy.ProjectBuildFile
- runtimeConfiguration - Variable in class org.savantbuild.plugin.groovy.BaseGroovyPlugin
- RuntimeConfiguration - Class in org.savantbuild.runtime
-
Runtime configuration for a Savant build run.
- RuntimeConfiguration() - Constructor for class org.savantbuild.runtime.RuntimeConfiguration
- RuntimeConfiguration(boolean, String...) - Constructor for class org.savantbuild.runtime.RuntimeConfiguration
- RuntimeConfigurationParser - Interface in org.savantbuild.runtime
-
Parses the command-line arguments and builds the
RuntimeConfigurationinstance.
S
- SemanticVersionDelegate - Class in org.savantbuild.parser.groovy
-
Groovy delegate that captures the semantic version mappings for a project.
- SemanticVersionDelegate(Map<String, Version>, Map<String, String>) - Constructor for class org.savantbuild.parser.groovy.SemanticVersionDelegate
- semanticVersions(Closure<?>) - Method in class org.savantbuild.parser.groovy.WorkflowDelegate
-
Configures the project's semantic version mappings.
- setProperty(String, Object) - Method in class org.savantbuild.parser.groovy.GlobalConfiguration
- size() - Method in class org.savantbuild.domain.Publications
- standard() - Method in class org.savantbuild.parser.groovy.PublicationsDelegate
-
Configures the standard project publications.
- standard() - Method in class org.savantbuild.parser.groovy.WorkflowDelegate
-
Configures the standard project workflow as follows:
- subversion(Map<String, Object>) - Method in class org.savantbuild.parser.groovy.WorkflowDelegate.ProcessDelegate
-
Adds a
SVNProcessto the workflow that uses the given attributes. - switches - Variable in class org.savantbuild.parser.groovy.ProjectBuildFile
- switches - Variable in class org.savantbuild.runtime.RuntimeConfiguration
-
The command-line switches.
- Switches - Class in org.savantbuild.runtime
-
A class that models command-line switches that might have values or not.
- Switches() - Constructor for class org.savantbuild.runtime.Switches
- SYS - Variable in class org.savantbuild.parser.groovy.ProjectBuildFile
T
- target(Map<String, Object>, Closure<?>) - Method in class org.savantbuild.parser.groovy.ProjectBuildFile
-
Adds a target to the project.
- Target - Class in org.savantbuild.domain
-
This class defines a target within the build file.
- Target() - Constructor for class org.savantbuild.domain.Target
- Target(String, String, Runnable, String...) - Constructor for class org.savantbuild.domain.Target
- targetGraph - Variable in class org.savantbuild.domain.Project
- TargetGraphBuilder - Interface in org.savantbuild.parser
-
Builds a Graph of target dependencies.
- targets - Variable in class org.savantbuild.domain.Project
- targets - Variable in class org.savantbuild.runtime.RuntimeConfiguration
-
The list of targets to execute (in order).
- toArtifact() - Method in class org.savantbuild.domain.Project
-
Converts this project into an Artifact.
- toListOfStrings(Object) - Static method in class org.savantbuild.parser.groovy.GroovyTools
-
Converts the object to a List of Strings.
- toString() - Method in class org.savantbuild.domain.Publications
- toString(Map<String, Object>, String) - Static method in class org.savantbuild.parser.groovy.GroovyTools
-
Safely converts an attribute to a String.
U
- url(Map<String, Object>) - Method in class org.savantbuild.parser.groovy.WorkflowDelegate.ProcessDelegate
-
Adds a
URLProcessto the workflow that uses the given attributes.
V
- values(String) - Method in class org.savantbuild.runtime.Switches
-
Returns the values for the given switch name.
- valueSwitches - Variable in class org.savantbuild.runtime.Switches
- version - Variable in class org.savantbuild.domain.Project
W
- workflow - Variable in class org.savantbuild.domain.Project
- workflow - Variable in class org.savantbuild.parser.groovy.WorkflowDelegate
- workflow(Closure<?>) - Method in class org.savantbuild.parser.groovy.ProjectDelegate
-
Configures the project workflow.
- WorkflowDelegate - Class in org.savantbuild.parser.groovy
-
Groovy delegate that captures the Workflow configuration from the project build file.
- WorkflowDelegate(Output, Workflow) - Constructor for class org.savantbuild.parser.groovy.WorkflowDelegate
- WorkflowDelegate.ProcessDelegate - Class in org.savantbuild.parser.groovy
-
Process delegate class that is used to configure
Processinstances for theFetchWorkflowandPublishWorkflowof theWorkflow.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form