Module com.io7m.changelog.core

Package com.io7m.changelog.core

Class CProjectName

java.lang.Object

com.io7m.changelog.core.CProjectName

All Implemented Interfaces:

CProjectNameType

public final class CProjectName
extends Object
implements CProjectNameType

The type of project names.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CProjectName.Builder	builder()	Creates a builder for CProjectName.
static CProjectName	copyOf(CProjectNameType instance)	Creates an immutable copy of a CProjectNameType value.
boolean	equals(Object another)	This instance is equal to all instances of CProjectName that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: value.
static CProjectName	of(String value)	Construct a new immutable CProjectName instance.
String	toString()	Prints the immutable value CProjectName with attribute values.
String	value()
CProjectName	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.CProjectNameType

checkPreconditions

Method Detail

value

public String value()

Specified by:

value in interface CProjectNameType

Returns:

The project name value

withValue

public final CProjectName 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 CProjectName 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 CProjectName with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static CProjectName of(String value)

Construct a new immutable CProjectName instance.

Parameters:

value - The value for the value attribute

Returns:

An immutable CProjectName instance

copyOf

public static CProjectName copyOf(CProjectNameType instance)

Creates an immutable copy of a CProjectNameType 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 CProjectName instance

builder

public static CProjectName.Builder builder()

Creates a builder for CProjectName.

Returns:

A new CProjectName builder