Package com.io7m.changelog.text

Class CChangelogTextWriterConfiguration

java.lang.Object

com.io7m.changelog.text.CChangelogTextWriterConfiguration

All Implemented Interfaces:

CChangelogTextWriterConfigurationType

public final class CChangelogTextWriterConfiguration
extends java.lang.Object
implements CChangelogTextWriterConfigurationType

The type of text writer configurations.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CChangelogTextWriterConfiguration.Builder	builder()	Creates a builder for CChangelogTextWriterConfiguration.
static CChangelogTextWriterConfiguration	copyOf(CChangelogTextWriterConfigurationType instance)	Creates an immutable copy of a CChangelogTextWriterConfigurationType value.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of CChangelogTextWriterConfiguration that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: release, showDates.
static CChangelogTextWriterConfiguration	of(java.util.Optional<? extends CVersionType> release, boolean showDates)	Construct a new immutable CChangelogTextWriterConfiguration instance.
java.util.Optional<CVersionType>	release()
boolean	showDates()
java.lang.String	toString()	Prints the immutable value CChangelogTextWriterConfiguration with attribute values.
CChangelogTextWriterConfiguration	withRelease(CVersionType value)	Copy the current immutable object by setting a present value for the optional release attribute.
CChangelogTextWriterConfiguration	withRelease(java.util.Optional<? extends CVersionType> optional)	Copy the current immutable object by setting an optional value for the release attribute.
CChangelogTextWriterConfiguration	withShowDates(boolean value)	Copy the current immutable object by setting a value for the showDates attribute.

Methods inherited from class java.lang.Object

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

Method Detail

release

public java.util.Optional<CVersionType> release()

Specified by:

release in interface CChangelogTextWriterConfigurationType

Returns:

The release, if any, to which the output should be restricted

showDates

public boolean showDates()

Specified by:

showDates in interface CChangelogTextWriterConfigurationType

Returns:

true iff dates should be shown in the output

withRelease

public final CChangelogTextWriterConfiguration withRelease(CVersionType value)

Copy the current immutable object by setting a present value for the optional release attribute.

Parameters:

value - The value for release

Returns:

A modified copy of this object

withRelease

public final CChangelogTextWriterConfiguration withRelease(java.util.Optional<? extends CVersionType> optional)

Copy the current immutable object by setting an optional value for the release attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.

Parameters:

optional - A value for release

Returns:

A modified copy of this object

withShowDates

public final CChangelogTextWriterConfiguration withShowDates(boolean value)

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

Parameters:

value - A new value for showDates

Returns:

A modified copy of the this object

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of CChangelogTextWriterConfiguration that have equal attribute values.

Overrides:

equals in class java.lang.Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: release, showDates.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value CChangelogTextWriterConfiguration with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static CChangelogTextWriterConfiguration of(java.util.Optional<? extends CVersionType> release,
                                                   boolean showDates)

Construct a new immutable CChangelogTextWriterConfiguration instance.

Parameters:

release - The value for the release attribute

showDates - The value for the showDates attribute

Returns:

An immutable CChangelogTextWriterConfiguration instance

copyOf

public static CChangelogTextWriterConfiguration copyOf(CChangelogTextWriterConfigurationType instance)

Creates an immutable copy of a CChangelogTextWriterConfigurationType 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 CChangelogTextWriterConfiguration instance

builder

public static CChangelogTextWriterConfiguration.Builder builder()

Creates a builder for CChangelogTextWriterConfiguration.

Returns:

A new CChangelogTextWriterConfiguration builder