com.github.searls.jasmine.config

Class ImmutableJasmineConfiguration.Builder

java.lang.Object

com.github.searls.jasmine.config.ImmutableJasmineConfiguration.Builder

Enclosing class:

ImmutableJasmineConfiguration

@NotThreadSafe
public static final class ImmutableJasmineConfiguration.Builder
extends Object

Builds instances of type ImmutableJasmineConfiguration. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method and Description
ImmutableJasmineConfiguration.Builder	addAllContexts(Iterable<? extends Context> elements) Adds elements to contexts list.
ImmutableJasmineConfiguration.Builder	addAllFileSystemReporters(Iterable<? extends FileSystemReporter> elements) Adds elements to fileSystemReporters list.
ImmutableJasmineConfiguration.Builder	addAllPreloadSources(Iterable<String> elements) Adds elements to preloadSources list.
ImmutableJasmineConfiguration.Builder	addAllReporters(Iterable<? extends Reporter> elements) Adds elements to reporters list.
ImmutableJasmineConfiguration.Builder	addContexts(Context... elements) Adds elements to contexts list.
ImmutableJasmineConfiguration.Builder	addContexts(Context element) Adds one element to contexts list.
ImmutableJasmineConfiguration.Builder	addFileSystemReporters(FileSystemReporter... elements) Adds elements to fileSystemReporters list.
ImmutableJasmineConfiguration.Builder	addFileSystemReporters(FileSystemReporter element) Adds one element to fileSystemReporters list.
ImmutableJasmineConfiguration.Builder	addPreloadSources(String... elements) Adds elements to preloadSources list.
ImmutableJasmineConfiguration.Builder	addPreloadSources(String element) Adds one element to preloadSources list.
ImmutableJasmineConfiguration.Builder	addReporters(Reporter... elements) Adds elements to reporters list.
ImmutableJasmineConfiguration.Builder	addReporters(Reporter element) Adds one element to reporters list.
ImmutableJasmineConfiguration.Builder	autoRefreshInterval(int autoRefreshInterval) Initializes the value for the autoRefreshInterval attribute.
ImmutableJasmineConfiguration.Builder	basedir(File basedir) Initializes the value for the basedir attribute.
ImmutableJasmineConfiguration	build() Builds a new ImmutableJasmineConfiguration.
ImmutableJasmineConfiguration.Builder	contexts(Iterable<? extends Context> elements) Sets or replaces all elements for contexts list.
ImmutableJasmineConfiguration.Builder	customRunnerConfiguration(File customRunnerConfiguration) Initializes the optional value customRunnerConfiguration to customRunnerConfiguration.
ImmutableJasmineConfiguration.Builder	customRunnerConfiguration(Optional<? extends File> customRunnerConfiguration) Initializes the optional value customRunnerConfiguration to customRunnerConfiguration.
ImmutableJasmineConfiguration.Builder	customRunnerTemplate(File customRunnerTemplate) Initializes the optional value customRunnerTemplate to customRunnerTemplate.
ImmutableJasmineConfiguration.Builder	customRunnerTemplate(Optional<? extends File> customRunnerTemplate) Initializes the optional value customRunnerTemplate to customRunnerTemplate.
ImmutableJasmineConfiguration.Builder	fileSystemReporters(Iterable<? extends FileSystemReporter> elements) Sets or replaces all elements for fileSystemReporters list.
ImmutableJasmineConfiguration.Builder	from(JasmineConfiguration instance) Fill a builder with attribute values from the provided JasmineConfiguration instance.
ImmutableJasmineConfiguration.Builder	jasmineTargetDir(File jasmineTargetDir) Initializes the value for the jasmineTargetDir attribute.
ImmutableJasmineConfiguration.Builder	preloadSources(Iterable<String> elements) Sets or replaces all elements for preloadSources list.
ImmutableJasmineConfiguration.Builder	projectClassLoader(ClassLoader projectClassLoader) Initializes the value for the projectClassLoader attribute.
ImmutableJasmineConfiguration.Builder	reporters(Iterable<? extends Reporter> elements) Sets or replaces all elements for reporters list.
ImmutableJasmineConfiguration.Builder	reporterType(ReporterType reporterType) Initializes the value for the reporterType attribute.
ImmutableJasmineConfiguration.Builder	sourceEncoding(String sourceEncoding) Initializes the value for the sourceEncoding attribute.
ImmutableJasmineConfiguration.Builder	sources(ScriptSearch sources) Initializes the value for the sources attribute.
ImmutableJasmineConfiguration.Builder	specDirectoryName(String specDirectoryName) Initializes the value for the specDirectoryName attribute.
ImmutableJasmineConfiguration.Builder	specRunnerHtmlFileName(String specRunnerHtmlFileName) Initializes the value for the specRunnerHtmlFileName attribute.
ImmutableJasmineConfiguration.Builder	specRunnerTemplate(SpecRunnerTemplate specRunnerTemplate) Initializes the value for the specRunnerTemplate attribute.
ImmutableJasmineConfiguration.Builder	specs(ScriptSearch specs) Initializes the value for the specs attribute.
ImmutableJasmineConfiguration.Builder	srcDirectoryName(String srcDirectoryName) Initializes the value for the srcDirectoryName attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public final ImmutableJasmineConfiguration.Builder from(JasmineConfiguration instance)

Fill a builder with attribute values from the provided JasmineConfiguration instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

basedir

public final ImmutableJasmineConfiguration.Builder basedir(File basedir)

Initializes the value for the basedir attribute.

Parameters:

basedir - The value for basedir

Returns:

this builder for use in a chained invocation

jasmineTargetDir

public final ImmutableJasmineConfiguration.Builder jasmineTargetDir(File jasmineTargetDir)

Initializes the value for the jasmineTargetDir attribute.

Parameters:

jasmineTargetDir - The value for jasmineTargetDir

Returns:

this builder for use in a chained invocation

srcDirectoryName

public final ImmutableJasmineConfiguration.Builder srcDirectoryName(String srcDirectoryName)

Initializes the value for the srcDirectoryName attribute.

If not set, this attribute will have a default value as returned by the initializer of srcDirectoryName.

Parameters:

srcDirectoryName - The value for srcDirectoryName

Returns:

this builder for use in a chained invocation

specDirectoryName

public final ImmutableJasmineConfiguration.Builder specDirectoryName(String specDirectoryName)

Initializes the value for the specDirectoryName attribute.

If not set, this attribute will have a default value as returned by the initializer of specDirectoryName.

Parameters:

specDirectoryName - The value for specDirectoryName

Returns:

this builder for use in a chained invocation

sources

public final ImmutableJasmineConfiguration.Builder sources(ScriptSearch sources)

Initializes the value for the sources attribute.

Parameters:

sources - The value for sources

Returns:

this builder for use in a chained invocation

specs

public final ImmutableJasmineConfiguration.Builder specs(ScriptSearch specs)

Initializes the value for the specs attribute.

Parameters:

specs - The value for specs

Returns:

this builder for use in a chained invocation

addContexts

public final ImmutableJasmineConfiguration.Builder addContexts(Context element)

Adds one element to contexts list.

Parameters:

element - A contexts element

Returns:

this builder for use in a chained invocation

addContexts

public final ImmutableJasmineConfiguration.Builder addContexts(Context... elements)

Adds elements to contexts list.

Parameters:

elements - An array of contexts elements

Returns:

this builder for use in a chained invocation

contexts

public final ImmutableJasmineConfiguration.Builder contexts(Iterable<? extends Context> elements)

Sets or replaces all elements for contexts list.

Parameters:

elements - An iterable of contexts elements

Returns:

this builder for use in a chained invocation

addAllContexts

public final ImmutableJasmineConfiguration.Builder addAllContexts(Iterable<? extends Context> elements)

Adds elements to contexts list.

Parameters:

elements - An iterable of contexts elements

Returns:

this builder for use in a chained invocation

addPreloadSources

public final ImmutableJasmineConfiguration.Builder addPreloadSources(String element)

Adds one element to preloadSources list.

Parameters:

element - A preloadSources element

Returns:

this builder for use in a chained invocation

addPreloadSources

public final ImmutableJasmineConfiguration.Builder addPreloadSources(String... elements)

Adds elements to preloadSources list.

Parameters:

elements - An array of preloadSources elements

Returns:

this builder for use in a chained invocation

preloadSources

public final ImmutableJasmineConfiguration.Builder preloadSources(Iterable<String> elements)

Sets or replaces all elements for preloadSources list.

Parameters:

elements - An iterable of preloadSources elements

Returns:

this builder for use in a chained invocation

addAllPreloadSources

public final ImmutableJasmineConfiguration.Builder addAllPreloadSources(Iterable<String> elements)

Adds elements to preloadSources list.

Parameters:

elements - An iterable of preloadSources elements

Returns:

this builder for use in a chained invocation

sourceEncoding

public final ImmutableJasmineConfiguration.Builder sourceEncoding(String sourceEncoding)

Initializes the value for the sourceEncoding attribute.

If not set, this attribute will have a default value as returned by the initializer of sourceEncoding.

Parameters:

sourceEncoding - The value for sourceEncoding

Returns:

this builder for use in a chained invocation

specRunnerTemplate

public final ImmutableJasmineConfiguration.Builder specRunnerTemplate(SpecRunnerTemplate specRunnerTemplate)

Initializes the value for the specRunnerTemplate attribute.

If not set, this attribute will have a default value as returned by the initializer of specRunnerTemplate.

Parameters:

specRunnerTemplate - The value for specRunnerTemplate

Returns:

this builder for use in a chained invocation

customRunnerTemplate

public final ImmutableJasmineConfiguration.Builder customRunnerTemplate(File customRunnerTemplate)

Initializes the optional value customRunnerTemplate to customRunnerTemplate.

Parameters:

customRunnerTemplate - The value for customRunnerTemplate

Returns:

this builder for chained invocation

customRunnerTemplate

public final ImmutableJasmineConfiguration.Builder customRunnerTemplate(Optional<? extends File> customRunnerTemplate)

Initializes the optional value customRunnerTemplate to customRunnerTemplate.

Parameters:

customRunnerTemplate - The value for customRunnerTemplate

Returns:

this builder for use in a chained invocation

customRunnerConfiguration

public final ImmutableJasmineConfiguration.Builder customRunnerConfiguration(File customRunnerConfiguration)

Initializes the optional value customRunnerConfiguration to customRunnerConfiguration.

Parameters:

customRunnerConfiguration - The value for customRunnerConfiguration

Returns:

this builder for chained invocation

customRunnerConfiguration

public final ImmutableJasmineConfiguration.Builder customRunnerConfiguration(Optional<? extends File> customRunnerConfiguration)

Initializes the optional value customRunnerConfiguration to customRunnerConfiguration.

Parameters:

customRunnerConfiguration - The value for customRunnerConfiguration

Returns:

this builder for use in a chained invocation

specRunnerHtmlFileName

public final ImmutableJasmineConfiguration.Builder specRunnerHtmlFileName(String specRunnerHtmlFileName)

Initializes the value for the specRunnerHtmlFileName attribute.

If not set, this attribute will have a default value as returned by the initializer of specRunnerHtmlFileName.

Parameters:

specRunnerHtmlFileName - The value for specRunnerHtmlFileName

Returns:

this builder for use in a chained invocation

reporterType

public final ImmutableJasmineConfiguration.Builder reporterType(ReporterType reporterType)

Initializes the value for the reporterType attribute.

If not set, this attribute will have a default value as returned by the initializer of reporterType.

Parameters:

reporterType - The value for reporterType

Returns:

this builder for use in a chained invocation

addReporters

public final ImmutableJasmineConfiguration.Builder addReporters(Reporter element)

Adds one element to reporters list.

Parameters:

element - A reporters element

Returns:

this builder for use in a chained invocation

addReporters

public final ImmutableJasmineConfiguration.Builder addReporters(Reporter... elements)

Adds elements to reporters list.

Parameters:

elements - An array of reporters elements

Returns:

this builder for use in a chained invocation

reporters

public final ImmutableJasmineConfiguration.Builder reporters(Iterable<? extends Reporter> elements)

Sets or replaces all elements for reporters list.

Parameters:

elements - An iterable of reporters elements

Returns:

this builder for use in a chained invocation

addAllReporters

public final ImmutableJasmineConfiguration.Builder addAllReporters(Iterable<? extends Reporter> elements)

Adds elements to reporters list.

Parameters:

elements - An iterable of reporters elements

Returns:

this builder for use in a chained invocation

addFileSystemReporters

public final ImmutableJasmineConfiguration.Builder addFileSystemReporters(FileSystemReporter element)

Adds one element to fileSystemReporters list.

Parameters:

element - A fileSystemReporters element

Returns:

this builder for use in a chained invocation

addFileSystemReporters

public final ImmutableJasmineConfiguration.Builder addFileSystemReporters(FileSystemReporter... elements)

Adds elements to fileSystemReporters list.

Parameters:

elements - An array of fileSystemReporters elements

Returns:

this builder for use in a chained invocation

fileSystemReporters

public final ImmutableJasmineConfiguration.Builder fileSystemReporters(Iterable<? extends FileSystemReporter> elements)

Sets or replaces all elements for fileSystemReporters list.

Parameters:

elements - An iterable of fileSystemReporters elements

Returns:

this builder for use in a chained invocation

addAllFileSystemReporters

public final ImmutableJasmineConfiguration.Builder addAllFileSystemReporters(Iterable<? extends FileSystemReporter> elements)

Adds elements to fileSystemReporters list.

Parameters:

elements - An iterable of fileSystemReporters elements

Returns:

this builder for use in a chained invocation

autoRefreshInterval

public final ImmutableJasmineConfiguration.Builder autoRefreshInterval(int autoRefreshInterval)

Initializes the value for the autoRefreshInterval attribute.

If not set, this attribute will have a default value as returned by the initializer of autoRefreshInterval.

Parameters:

autoRefreshInterval - The value for autoRefreshInterval

Returns:

this builder for use in a chained invocation

projectClassLoader

public final ImmutableJasmineConfiguration.Builder projectClassLoader(ClassLoader projectClassLoader)

Initializes the value for the projectClassLoader attribute.

If not set, this attribute will have a default value as returned by the initializer of projectClassLoader.

Parameters:

projectClassLoader - The value for projectClassLoader

Returns:

this builder for use in a chained invocation

build

public ImmutableJasmineConfiguration build()

Builds a new ImmutableJasmineConfiguration.

Returns:

An immutable instance of JasmineConfiguration

Throws:

IllegalStateException - if any required attributes are missing