Package com.io7m.minisite.core

Class MinDocumentationItem

java.lang.Object

com.io7m.minisite.core.MinDocumentationItem

All Implemented Interfaces:

MinDocumentationItemType

public final class MinDocumentationItem
extends java.lang.Object
implements MinDocumentationItemType

Configuration for a documentation item.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static MinDocumentationItem.Builder	builder()	Creates a builder for MinDocumentationItem.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of MinDocumentationItem that have equal attribute values.
io.vavr.collection.Vector<MinDocumentationFormat>	formats()
int	hashCode()	Computes a hash code from attributes: name, formats.
java.lang.String	name()
static MinDocumentationItem	of(java.lang.String name, io.vavr.collection.Vector<MinDocumentationFormat> formats)	Construct a new immutable MinDocumentationItem instance.
java.lang.String	toString()	Prints the immutable value MinDocumentationItem 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 MinDocumentationItemType

Returns:

The name of the documentation, such as "User documentation"

formats

public io.vavr.collection.Vector<MinDocumentationFormat> formats()

Specified by:

formats in interface MinDocumentationItemType

Returns:

The list of available formats for the documentation

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of MinDocumentationItem 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, formats.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value MinDocumentationItem with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static MinDocumentationItem of(java.lang.String name,
                                      io.vavr.collection.Vector<MinDocumentationFormat> formats)

Construct a new immutable MinDocumentationItem instance.

Parameters:

name - The value for the name attribute

formats - The value for the formats attribute

Returns:

An immutable MinDocumentationItem instance

builder

public static MinDocumentationItem.Builder builder()

Creates a builder for MinDocumentationItem.

Returns:

A new MinDocumentationItem builder