Module com.io7m.changelog.core

Package com.io7m.changelog.core

Class CModuleName

java.lang.Object

com.io7m.changelog.core.CModuleName

All Implemented Interfaces:

CModuleNameType

public final class CModuleName
extends Object
implements CModuleNameType

The type of module names.

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.io7m.changelog.core.CModuleNameType

checkPreconditions

Method Detail

value

public String value()

Specified by:

value in interface CModuleNameType

Returns:

The module name value

withValue

public final CModuleName withValue(String value)

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

Parameters:

value - A new value for value

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of CModuleName 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: value.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value CModuleName with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static CModuleName of(String value)

Construct a new immutable CModuleName instance.

Parameters:

value - The value for the value attribute

Returns:

An immutable CModuleName instance

copyOf

public static CModuleName copyOf(CModuleNameType instance)

Creates an immutable copy of a CModuleNameType 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 CModuleName instance

builder

public static CModuleName.Builder builder()

Creates a builder for CModuleName.

Returns:

A new CModuleName builder