Package com.io7m.minisite.core

Class MinChangesConfiguration

java.lang.Object

com.io7m.minisite.core.MinChangesConfiguration

All Implemented Interfaces:

MinChangesConfigurationType

public final class MinChangesConfiguration
extends Object
implements MinChangesConfigurationType

Configurations for changelogs.

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Details

file

public Path file()

Specified by:

file in interface MinChangesConfigurationType

Returns:

The changelog file

feedEmail

public String feedEmail()

Specified by:

feedEmail in interface MinChangesConfigurationType

Returns:

The email used for the changelog atom feed

withFile

public final MinChangesConfiguration withFile(Path value)

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

Parameters:

value - A new value for file

Returns:

A modified copy of the this object

withFeedEmail

public final MinChangesConfiguration withFeedEmail(String value)

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

Parameters:

value - A new value for feedEmail

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of MinChangesConfiguration 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: file, feedEmail.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value MinChangesConfiguration with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static MinChangesConfiguration of(Path file,
 String feedEmail)

Construct a new immutable MinChangesConfiguration instance.

Parameters:

file - The value for the file attribute

feedEmail - The value for the feedEmail attribute

Returns:

An immutable MinChangesConfiguration instance

copyOf

public static MinChangesConfiguration copyOf(MinChangesConfigurationType instance)

Creates an immutable copy of a MinChangesConfigurationType 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 MinChangesConfiguration instance

builder

public static MinChangesConfiguration.Builder builder()

Creates a builder for MinChangesConfiguration.

 MinChangesConfiguration.builder()
    .setFile(java.nio.file.Path) // required file
    .setFeedEmail(String) // required feedEmail
    .build();
 

Returns:

A new MinChangesConfiguration builder