Module com.io7m.changelog.core

Package com.io7m.changelog.core

Class CTicketID

java.lang.Object

com.io7m.changelog.core.CTicketID

All Implemented Interfaces:

CTicketIDType

public final class CTicketID
extends Object
implements CTicketIDType

The type of ticket IDs.

Nested Class Summary

Nested Classes

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

Method Summary

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

checkPreconditions

Method Detail

value

public String value()

Specified by:

value in interface CTicketIDType

Returns:

The ticket ID value

withValue

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

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static CTicketID of(String value)

Construct a new immutable CTicketID instance.

Parameters:

value - The value for the value attribute

Returns:

An immutable CTicketID instance

copyOf

public static CTicketID copyOf(CTicketIDType instance)

Creates an immutable copy of a CTicketIDType 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 CTicketID instance

builder

public static CTicketID.Builder builder()

Creates a builder for CTicketID.

Returns:

A new CTicketID builder