Package com.github.searls.jasmine.model

Class ImmutableScriptSearch

java.lang.Object

com.github.searls.jasmine.model.ImmutableScriptSearch

All Implemented Interfaces:

ScriptSearch

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableScriptSearch
extends Object
implements ScriptSearch

Immutable implementation of ScriptSearch.

Use the builder to create immutable instances: ImmutableScriptSearch.builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImmutableScriptSearch.Builder	Builds instances of type ImmutableScriptSearch.

Method Summary

Modifier and Type	Method	Description
static ImmutableScriptSearch.Builder	builder()	Creates a builder for ImmutableScriptSearch.
static ImmutableScriptSearch	copyOf(ScriptSearch instance)	Creates an immutable copy of a ScriptSearch value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableScriptSearch that have equal attribute values.
File	getDirectory()
com.google.common.collect.ImmutableList<String>	getExcludes()
com.google.common.collect.ImmutableList<String>	getIncludes()
int	hashCode()	Computes a hash code from attributes: directory, includes, excludes.
String	toString()	Prints the immutable value ScriptSearch with attribute values.
ImmutableScriptSearch	withDirectory(File value)	Copy the current immutable object by setting a value for the directory attribute.
ImmutableScriptSearch	withExcludes(Iterable<String> elements)	Copy the current immutable object with elements that replace the content of excludes.
ImmutableScriptSearch	withExcludes(String... elements)	Copy the current immutable object with elements that replace the content of excludes.
ImmutableScriptSearch	withIncludes(Iterable<String> elements)	Copy the current immutable object with elements that replace the content of includes.
ImmutableScriptSearch	withIncludes(String... elements)	Copy the current immutable object with elements that replace the content of includes.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getDirectory

public File getDirectory()

Specified by:

getDirectory in interface ScriptSearch

Returns:

The value of the directory attribute

getIncludes

public com.google.common.collect.ImmutableList<String> getIncludes()

Specified by:

getIncludes in interface ScriptSearch

Returns:

The value of the includes attribute

getExcludes

public com.google.common.collect.ImmutableList<String> getExcludes()

Specified by:

getExcludes in interface ScriptSearch

Returns:

The value of the excludes attribute

withDirectory

public final ImmutableScriptSearch withDirectory(File value)

Copy the current immutable object by setting a value for the directory attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for directory

Returns:

A modified copy of the this object

withIncludes

public final ImmutableScriptSearch withIncludes(String... elements)

Copy the current immutable object with elements that replace the content of includes.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withIncludes

public final ImmutableScriptSearch withIncludes(Iterable<String> elements)

Copy the current immutable object with elements that replace the content of includes. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of includes elements to set

Returns:

A modified copy of this object

withExcludes

public final ImmutableScriptSearch withExcludes(String... elements)

Copy the current immutable object with elements that replace the content of excludes.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withExcludes

public final ImmutableScriptSearch withExcludes(Iterable<String> elements)

Copy the current immutable object with elements that replace the content of excludes. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of excludes elements to set

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableScriptSearch that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: directory, includes, excludes.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ScriptSearch with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableScriptSearch copyOf(ScriptSearch instance)

Creates an immutable copy of a ScriptSearch value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable ScriptSearch instance

builder

public static ImmutableScriptSearch.Builder builder()

Creates a builder for ImmutableScriptSearch.

 ImmutableScriptSearch.builder()
    .directory(java.io.File) // required directory
    .addIncludes|addAllIncludes(String) // includes elements
    .addExcludes|addAllExcludes(String) // excludes elements
    .build();
 

Returns:

A new ImmutableScriptSearch builder