package sbuild

SBuild API Reference

This package contains SBuild core classes and public API.

Project Homepage:

SBuild is released under the Apache License, Version 2.0.

SBuild API to be used in SBuild build scripts

The following classes form SBUild's public API:

Classes and objects, not listed above are candidates to change in succeeding releases. You are encouraged, to use only the API form above in your build scripts.

Default Scheme Handlers

The following list of SchemeHandler implementations are registered by-default with their default configuration in each SBuild project. To register or overwrite a scheme handler in your project, you should use SchemeHandler$.apply.



Linear Supertypes
AnyRef, Any
  1. Alphabetic
  2. By inheritance
  1. sbuild
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
  1. Public
  2. All

Type Members

  1. class BuildFileProject extends Project

  2. trait BuildScriptAware extends AnyRef

  3. class ExecutionFailedException extends SBuildException

    The execution of an target, which was defined in the project file, failed.

  4. trait ExperimentalPlugin extends AnyRef

    WARNING: Do not use this experimental API

  5. class HttpSchemeHandler extends HttpSchemeHandlerBase with SchemeResolver

    An HTTP-Scheme handler, that will download the given URI into a directory preserving the URI as path.

  6. class HttpSchemeHandlerBase extends SchemeHandler

  7. class InvalidApiUsageException extends ProjectConfigurationException

    Invalid use of SBuild API.

  8. class InvalidCommandlineException extends SBuildException

    An invalid commandline was given.

  9. trait LocalizableSupport[E] extends AnyRef

  10. trait LogLevel extends AnyRef

  11. class MapperSchemeHandler extends SchemeHandler

    A MapperSchemeHandler will maintain an mapping from on scheme to another scheme.

  12. class MissingConfigurationException extends SBuildException

    An required but not-configured property was accessed.

  13. class Module extends AnyRef

  14. trait MutableProject extends ProjectBase

  15. class MvnSchemeHandler extends SchemeResolver

    A SchemeHandler able to download Maven artifacts from a set of Maven repositories.

  16. class OSGiVersion extends Comparable[OSGiVersion]

    Version identifier for bundles and packages.

  17. trait Project extends MutableProject with ProjectAntSupport

  18. trait ProjectAntSupport extends AnyRef

  19. trait ProjectBase extends AnyRef

  20. class ProjectConfigurationException extends SBuildException

    A error was detected while parsing and/or initializing the project.

  21. class ProjectPool extends AnyRef

  22. trait ProjectReader extends AnyRef

  23. case class ProjectTarget extends Target with Product with Serializable

  24. case class ResolveResult(wasUpToDate: Boolean, error: Option[Throwable]) extends Product with Serializable

  25. class SBuildConsoleLogger extends SBuildLogger

  26. class SBuildException extends RuntimeException with BuildScriptAware with TargetAware

    Common superclass for specific SBuild exceptions.

  27. trait SBuildLogger extends AnyRef

  28. class ScanSchemeHandler extends SchemeResolver with TransparentSchemeResolver with SideeffectFreeSchemeResolver

    Scans a directory for files, recursiv.

  29. trait SchemeHandler extends AnyRef

    Translates a target name into another target name

  30. trait SchemeResolver extends SchemeHandler

    A SchemeHandler, that also resolves the representing target.

  31. trait SchemeResolverWithDependencies extends SchemeResolver

  32. trait SideeffectFreeSchemeResolver extends SchemeResolver

    An internal marker interface.

  33. trait Target extends AnyRef

  34. trait TargetAware extends AnyRef

  35. trait TargetContext extends AnyRef

    While a target is executed, this trait can be used to get relevant information about the current target execution and interact with the executor.

  36. class TargetContextImpl extends TargetContext

  37. class TargetNotFoundException extends SBuildException

    An unknown target was requested (on command line or as a dependency).

  38. class TargetRef extends AnyRef

  39. case class TargetRefs(targetRefs: TargetRef*) extends Product with Serializable

  40. trait TransparentSchemeResolver extends SchemeResolver

    An internal marker interface.

  41. case class UniqueTargetFile(file: File, phony: Boolean, handler: Option[SchemeHandler]) extends Product with Serializable

  42. class UnsupportedSchemeException extends SBuildException

    An unsupported scheme was used in a target or dependency.

  43. trait WithinTargetExecution extends AnyRef

  44. class ZipSchemeHandler extends SchemeResolver with SchemeResolverWithDependencies

  45. class classpath extends Annotation

    Add additional classpath elements (jars, dirs) to the compile and execution environment of the current build file.

  46. class include extends Annotation

    Include one ore more Scala files to access them from the current project.

  47. class version extends Annotation

  48. trait SchemeHandlerWithDependencies extends SchemeResolverWithDependencies


    (Since version 0.4.1) Use SchemeResolverWithDependencies instead.

Value Members

  1. object ExecutionFailedException extends LocalizableSupport[ExecutionFailedException] with Serializable

  2. object ExperimentalPlugin

    WARNING: Do not use this experimental API

  3. object ExportDependencies

    Export dependencies to be consumed by other tools, e.

  4. object InvalidApiUsageException extends LocalizableSupport[InvalidApiUsageException] with Serializable

  5. object InvalidCommandlineException extends LocalizableSupport[InvalidCommandlineException] with Serializable

  6. object LogLevel

  7. object MavenSupport

  8. object MissingConfigurationException extends LocalizableSupport[MissingConfigurationException] with Serializable

  9. object Module

  10. object Modules

  11. object OSGiVersion

  12. object Path

  13. object Paths

  14. object ProjectConfigurationException extends LocalizableSupport[ProjectConfigurationException] with Serializable

  15. object Prop

  16. object SBuildNoneLogger extends SBuildLogger

  17. object SBuildVersion

  18. object SchemeHandler

    Register a SchemeHandler under a scheme qualifier into the current project.

  19. object SetProp

  20. object Target

  21. object TargetNotFoundException extends LocalizableSupport[TargetNotFoundException] with Serializable

  22. object TargetRef

  23. object TargetRefs extends Serializable

  24. object UnsupportedSchemeException extends LocalizableSupport[UnsupportedSchemeException] with Serializable

  25. object Util

  26. object WithinTargetExecution extends ThreadLocal[WithinTargetExecution]

  27. package embedded

  28. package runner

Deprecated Value Members

  1. object Pathes


    (Since version Use Paths instead.

Inherited from AnyRef

Inherited from Any