Package com.io7m.minisite.core

Class MinConfiguration

java.lang.Object

com.io7m.minisite.core.MinConfiguration

All Implemented Interfaces:

MinConfigurationType

public final class MinConfiguration
extends java.lang.Object
implements MinConfigurationType

Configurations for sites.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
java.util.Optional<MinBugTrackerConfiguration>	bugTracker()
static MinConfiguration.Builder	builder()	Creates a builder for MinConfiguration.
java.lang.String	centralReposPath()
java.util.Optional<MinChangesConfiguration>	changelog()
boolean	equals(java.lang.Object another)	This instance is equal to all instances of MinConfiguration that have equal attribute values.
java.util.Optional<java.nio.file.Path>	features()
int	hashCode()	Computes a hash code from attributes: projectName, projectGroupName, projectModules, release, centralReposPath, overview, features, changelog, license, bugTracker, sources.
java.util.Optional<java.nio.file.Path>	license()
static MinConfiguration	of(java.lang.String projectName, java.lang.String projectGroupName, io.vavr.collection.Vector<java.lang.String> projectModules, java.lang.String release, java.lang.String centralReposPath, java.util.Optional<? extends java.nio.file.Path> overview, java.util.Optional<? extends java.nio.file.Path> features, java.util.Optional<? extends MinChangesConfiguration> changelog, java.util.Optional<? extends java.nio.file.Path> license, java.util.Optional<? extends MinBugTrackerConfiguration> bugTracker, java.util.Optional<? extends MinSourcesConfiguration> sources)	Construct a new immutable MinConfiguration instance.
java.util.Optional<java.nio.file.Path>	overview()
java.lang.String	projectGroupName()
io.vavr.collection.Vector<java.lang.String>	projectModules()
java.lang.String	projectName()
java.lang.String	release()
java.util.Optional<MinSourcesConfiguration>	sources()
java.lang.String	toString()	Prints the immutable value MinConfiguration with attribute values.

Methods inherited from class java.lang.Object

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

Method Detail

projectName

public java.lang.String projectName()

Specified by:

projectName in interface MinConfigurationType

Returns:

The name of the project

projectGroupName

public java.lang.String projectGroupName()

Specified by:

projectGroupName in interface MinConfigurationType

Returns:

The group name of the project

projectModules

public io.vavr.collection.Vector<java.lang.String> projectModules()

Specified by:

projectModules in interface MinConfigurationType

Returns:

The project modules

release

public java.lang.String release()

Specified by:

release in interface MinConfigurationType

Returns:

The version number of the current release

centralReposPath

public java.lang.String centralReposPath()

Specified by:

centralReposPath in interface MinConfigurationType

Returns:

The path to the project within the Central Repository

overview

public java.util.Optional<java.nio.file.Path> overview()

Specified by:

overview in interface MinConfigurationType

Returns:

An XHTML file containing an overview of the project

features

public java.util.Optional<java.nio.file.Path> features()

Specified by:

features in interface MinConfigurationType

Returns:

An XHTML file containing the features of the project

changelog

public java.util.Optional<MinChangesConfiguration> changelog()

Specified by:

changelog in interface MinConfigurationType

Returns:

The changelog configuration, if any

license

public java.util.Optional<java.nio.file.Path> license()

Specified by:

license in interface MinConfigurationType

Returns:

A plain text file containing the project license

bugTracker

public java.util.Optional<MinBugTrackerConfiguration> bugTracker()

Specified by:

bugTracker in interface MinConfigurationType

Returns:

The bug tracker configuration, if any

sources

public java.util.Optional<MinSourcesConfiguration> sources()

Specified by:

sources in interface MinConfigurationType

Returns:

The project source configuration, if any

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of MinConfiguration 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: projectName, projectGroupName, projectModules, release, centralReposPath, overview, features, changelog, license, bugTracker, sources.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value MinConfiguration with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static MinConfiguration of(java.lang.String projectName,
                                  java.lang.String projectGroupName,
                                  io.vavr.collection.Vector<java.lang.String> projectModules,
                                  java.lang.String release,
                                  java.lang.String centralReposPath,
                                  java.util.Optional<? extends java.nio.file.Path> overview,
                                  java.util.Optional<? extends java.nio.file.Path> features,
                                  java.util.Optional<? extends MinChangesConfiguration> changelog,
                                  java.util.Optional<? extends java.nio.file.Path> license,
                                  java.util.Optional<? extends MinBugTrackerConfiguration> bugTracker,
                                  java.util.Optional<? extends MinSourcesConfiguration> sources)

Construct a new immutable MinConfiguration instance.

Parameters:

projectName - The value for the projectName attribute

projectGroupName - The value for the projectGroupName attribute

projectModules - The value for the projectModules attribute

release - The value for the release attribute

centralReposPath - The value for the centralReposPath attribute

overview - The value for the overview attribute

features - The value for the features attribute

changelog - The value for the changelog attribute

license - The value for the license attribute

bugTracker - The value for the bugTracker attribute

sources - The value for the sources attribute

Returns:

An immutable MinConfiguration instance

builder

public static MinConfiguration.Builder builder()

Creates a builder for MinConfiguration.

Returns:

A new MinConfiguration builder