Module com.io7m.changelog.core

Package com.io7m.changelog.core

Class CVersionText

java.lang.Object

com.io7m.changelog.core.CVersionText

All Implemented Interfaces:

CVersionTextType, CVersionType, Comparable<CVersionType>

public final class CVersionText
extends Object
implements CVersionTextType

The type of arbitrary lexicographically ordered version strings.

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from class java.lang.Object

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

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

compareTo, toVersionString, versionAccept

Method Detail

text

public String text()

Specified by:

text in interface CVersionTextType

Returns:

The version number text

withText

public final CVersionText withText(String value)

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

Parameters:

value - A new value for text

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

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

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value CVersionText with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static CVersionText of(String text)

Construct a new immutable CVersionText instance.

Parameters:

text - The value for the text attribute

Returns:

An immutable CVersionText instance

copyOf

public static CVersionText copyOf(CVersionTextType instance)

Creates an immutable copy of a CVersionTextType 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 CVersionText instance

builder

public static CVersionText.Builder builder()

Creates a builder for CVersionText.

Returns:

A new CVersionText builder