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:

The following classes are currently experimental or not part of the 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
TargetRefsImplicits, AnyRef, Any
  1. Alphabetic
  2. By inheritance
  1. sbuild
  2. TargetRefsImplicits
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
  1. Public
  2. All

Type Members

  1. trait BuildScriptAware extends AnyRef

  2. class BuildfileCompilationException extends ProjectConfigurationException

    Invalid use of SBuild API.

  3. trait CmdlineMonitor extends AnyRef

  4. class ExecutionFailedException extends SBuildException

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

  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 Logger extends Serializable

  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 OutputStreamCmdlineMonitor extends CmdlineMonitor

  17. trait Plugin[T] extends AnyRef

    An implementation of this trait act as a plugin activator.

  18. trait PluginAware extends AnyRef

  19. trait Project extends MutableProject with ProjectAntSupport with PluginAware

  20. trait ProjectAntSupport extends AnyRef

  21. trait ProjectBase extends AnyRef

  22. class ProjectConfigurationException extends SBuildException

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

  23. class ProjectPool extends AnyRef

  24. trait ProjectReader extends AnyRef

  25. class ProjectTarget extends Target

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

  27. final class RichFile extends AnyVal

  28. class SBuildException extends RuntimeException with BuildScriptAware with TargetAware

    Common superclass for specific SBuild exceptions.

  29. class ScanSchemeHandler extends SchemeResolver with TransparentSchemeResolver with SideeffectFreeSchemeResolver

    Scans a directory for files, recursiv.

  30. trait SchemeHandler extends AnyRef

    Translates a target name into another target name

  31. trait SchemeResolver extends SchemeHandler

    A SchemeHandler, that also resolves the representing target.

  32. trait SchemeResolverWithDependencies extends SchemeResolver

  33. trait SideeffectFreeSchemeResolver extends SchemeResolver

    An internal marker interface.

  34. trait Target extends AnyRef

  35. trait TargetAware extends AnyRef

  36. 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.

  37. class TargetContextImpl extends TargetContext

  38. class TargetNameMatcher extends AnyRef

  39. class TargetNotFoundException extends SBuildException

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

  40. class TargetRef extends AnyRef

  41. class TargetRefs extends AnyRef

  42. trait TargetRefsImplicits extends AnyRef

  43. trait TransparentSchemeResolver extends SchemeResolver

    An internal marker interface.

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

  45. class UnsupportedSchemeException extends SBuildException

    An unsupported scheme was used in a target or dependency.

  46. class ZipSchemeHandler extends SchemeResolver with SchemeResolverWithDependencies

    The SchemeHandler to extract resources from a ZIP resource.

  47. class classpath extends Annotation

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

  48. class include extends Annotation

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

  49. class version extends Annotation

  50. class OSGiVersion extends Comparable[OSGiVersion]

    Version identifier for bundles and packages.

  51. trait SchemeHandlerWithDependencies extends SchemeResolverWithDependencies


    (Since version 0.4.1) Use SchemeResolverWithDependencies instead.

Value Members

  1. object BuildfileCompilationException extends LocalizableSupport[BuildfileCompilationException] with Serializable

  2. object CmdlineMonitor

  3. object Constants

  4. object ExecutionFailedException extends LocalizableSupport[ExecutionFailedException] with Serializable

  5. object ExportDependencies

    Export dependencies to be consumed by other tools, e.

  6. object InvalidApiUsageException extends LocalizableSupport[InvalidApiUsageException] with Serializable

  7. object InvalidCommandlineException extends LocalizableSupport[InvalidCommandlineException] with Serializable

  8. object Logger extends Serializable

  9. object MavenSupport

  10. object MissingConfigurationException extends LocalizableSupport[MissingConfigurationException] with Serializable

  11. object Module

  12. object Modules

  13. object NoopCmdlineMonitor extends CmdlineMonitor

  14. object Path

    Path can be used to produce absolute File instances which are relative to the current SBuild project directory or the directory containing an included and explicit requested project resource.

  15. object Paths

  16. object Plugin

    This object contains useful apply method to activate and access plugin instances.

  17. object ProjectConfigurationException extends LocalizableSupport[ProjectConfigurationException] with Serializable

  18. object Prop

  19. object RichFile

  20. object SBuildVersion

  21. object SchemeHandler

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

  22. object SetProp

  23. object Target

  24. object TargetNameMatcher

  25. object TargetNotFoundException extends LocalizableSupport[TargetNotFoundException] with Serializable

  26. object TargetRef

  27. object TargetRefs extends TargetRefsImplicits

  28. object UnsupportedSchemeException extends LocalizableSupport[UnsupportedSchemeException] with Serializable

  29. package execute

  30. package internal

  31. implicit def toRichFile(file: File): RichFile

  32. implicit def toTargetRefs_fromFile(file: File)(implicit project: Project): TargetRefs

    Definition Classes
  33. implicit def toTargetRefs_fromSeq(targetRefs: Seq[TargetRef]): TargetRefs

    Definition Classes
  34. implicit def toTargetRefs_fromString(string: String)(implicit project: Project): TargetRefs

    Definition Classes
  35. implicit def toTargetRefs_fromTarget(target: Target): TargetRefs

    Definition Classes
  36. implicit def toTargetRefs_fromTargetRef(targetRef: TargetRef): TargetRefs

    Definition Classes

Deprecated Value Members

  1. object OSGiVersion


    (Since version Use internal.OSGiVersion instead

  2. object Pathes


    (Since version Use Paths instead.

  3. object ResolveFiles

    EXPERIMENTAL API - Resolve TargetRefs.

  4. object Util extends Util

    This is not public API of SBuild.

Inherited from TargetRefsImplicits

Inherited from AnyRef

Inherited from Any