Package com.io7m.minisite.core

Class MinSourcesConfiguration

java.lang.Object

com.io7m.minisite.core.MinSourcesConfiguration

All Implemented Interfaces:

MinSourcesConfigurationType

public final class MinSourcesConfiguration
extends Object
implements MinSourcesConfigurationType

Configurations for source code repositories.

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Details

system

public String system()

Specified by:

system in interface MinSourcesConfigurationType

Returns:

The SCM system (such as "Git")

uri

public URI uri()

Specified by:

uri in interface MinSourcesConfigurationType

Returns:

The repository URL

withSystem

public final MinSourcesConfiguration withSystem(String value)

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

Parameters:

value - A new value for system

Returns:

A modified copy of the this object

withUri

public final MinSourcesConfiguration withUri(URI value)

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

Parameters:

value - A new value for uri

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of MinSourcesConfiguration 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: system, uri.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value MinSourcesConfiguration with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static MinSourcesConfiguration of(String system,
 URI uri)

Construct a new immutable MinSourcesConfiguration instance.

Parameters:

system - The value for the system attribute

uri - The value for the uri attribute

Returns:

An immutable MinSourcesConfiguration instance

copyOf

public static MinSourcesConfiguration copyOf(MinSourcesConfigurationType instance)

Creates an immutable copy of a MinSourcesConfigurationType 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 MinSourcesConfiguration instance

builder

public static MinSourcesConfiguration.Builder builder()

Creates a builder for MinSourcesConfiguration.

 MinSourcesConfiguration.builder()
    .setSystem(String) // required system
    .setUri(java.net.URI) // required uri
    .build();
 

Returns:

A new MinSourcesConfiguration builder