com.io7m.sombrero.core

Class SoShaderModule

java.lang.Object

com.io7m.sombrero.core.SoShaderModule

All Implemented Interfaces:

SoShaderModuleType

@Generated(value={"Immutables.generator","SoShaderModuleType"})
public final class SoShaderModule
extends Object
implements SoShaderModuleType

The type of shader modules.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static SoShaderModule.Builder	builder() Creates a builder for SoShaderModule.
static SoShaderModule	copyOf(SoShaderModuleType instance) Creates an immutable copy of a SoShaderModuleType value.
boolean	equals(Object another) This instance is equal to all instances of SoShaderModule that have equal attribute values.
int	hashCode() Computes a hash code from attributes: name, store.
String	name()
static SoShaderModule	of(String name, SoShaderStoreType store) Construct a new immutable SoShaderModule instance.
SoShaderStoreType	store()
String	toString() Prints the immutable value SoShaderModule with attribute values.
SoShaderModule	withName(String value) Copy the current immutable object by setting a value for the name attribute.
SoShaderModule	withStore(SoShaderStoreType value) Copy the current immutable object by setting a value for the store attribute.

Methods inherited from class java.lang.Object

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

Method Detail

name

public String name()

Specified by:

name in interface SoShaderModuleType

Returns:

The module name

store

public SoShaderStoreType store()

Specified by:

store in interface SoShaderModuleType

Returns:

The primary shader store for the module

withName

public final SoShaderModule withName(String value)

Copy the current immutable object by setting a value for the name attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for name

Returns:

A modified copy of the this object

withStore

public final SoShaderModule withStore(SoShaderStoreType value)

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

Parameters:

value - A new value for store

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of SoShaderModule 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: name, store.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value SoShaderModule with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static SoShaderModule of(String name,
                                SoShaderStoreType store)

Construct a new immutable SoShaderModule instance.

Parameters:

name - The value for the name attribute

store - The value for the store attribute

Returns:

An immutable SoShaderModule instance

copyOf

public static SoShaderModule copyOf(SoShaderModuleType instance)

Creates an immutable copy of a SoShaderModuleType 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 SoShaderModule instance

builder

public static SoShaderModule.Builder builder()

Creates a builder for SoShaderModule.

Returns:

A new SoShaderModule builder