Package com.io7m.minisite.core

Class MinDocumentationFormat

java.lang.Object

com.io7m.minisite.core.MinDocumentationFormat

All Implemented Interfaces:

MinDocumentationFormatType

public final class MinDocumentationFormat
extends java.lang.Object
implements MinDocumentationFormatType

Configuration for a documentation format.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static MinDocumentationFormat.Builder	builder()	Creates a builder for MinDocumentationFormat.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of MinDocumentationFormat that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: name, path.
java.lang.String	name()
static MinDocumentationFormat	of(java.lang.String name, java.nio.file.Path path)	Construct a new immutable MinDocumentationFormat instance.
java.nio.file.Path	path()
java.lang.String	toString()	Prints the immutable value MinDocumentationFormat with attribute values.

Methods inherited from class java.lang.Object

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

Method Detail

name

public java.lang.String name()

Specified by:

name in interface MinDocumentationFormatType

Returns:

The name of the format, such as "XHTML - one page per section"

path

public java.nio.file.Path path()

Specified by:

path in interface MinDocumentationFormatType

Returns:

The path to the format, such as "/documentation/index-m.xhtml"

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of MinDocumentationFormat 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: name, path.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value MinDocumentationFormat with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static MinDocumentationFormat of(java.lang.String name,
                                        java.nio.file.Path path)

Construct a new immutable MinDocumentationFormat instance.

Parameters:

name - The value for the name attribute

path - The value for the path attribute

Returns:

An immutable MinDocumentationFormat instance

builder

public static MinDocumentationFormat.Builder builder()

Creates a builder for MinDocumentationFormat.

Returns:

A new MinDocumentationFormat builder