com.io7m.jstructural.core

Class SSubsection

java.lang.Object

com.io7m.jstructural.core.SSubsection

@Immutable
public final class SSubsection
extends Object

A subsection.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
SNonEmptyList<SSubsectionContent>	getContent()
com.io7m.jfunctional.OptionType<SID>	getID()
SSubsectionTitle	getTitle()
com.io7m.jfunctional.OptionType<String>	getType()
int	hashCode()
static SSubsection	subsection(SSubsectionTitle in_title, SNonEmptyList<SSubsectionContent> in_content) Create a subsection with the given title and content.
static SSubsection	subsectionID(SID id, SSubsectionTitle in_title, SNonEmptyList<SSubsectionContent> in_content) Create a subsection with the given id, title, and content.
static SSubsection	subsectionTyped(String type, SSubsectionTitle in_title, SNonEmptyList<SSubsectionContent> in_content) Create a subsection with the given type, title, and content.
static SSubsection	subsectionTypedID(String type, SID id, SSubsectionTitle in_title, SNonEmptyList<SSubsectionContent> in_content) Create a subsection with the given type, id, title, and content.

Methods inherited from class java.lang.Object

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

Method Detail

subsection

public static SSubsection subsection(SSubsectionTitle in_title,
                                     SNonEmptyList<SSubsectionContent> in_content)

Create a subsection with the given title and content.

Parameters:

in_title - The title

in_content - The content

Returns:

A new subsection

subsectionID

public static SSubsection subsectionID(SID id,
                                       SSubsectionTitle in_title,
                                       SNonEmptyList<SSubsectionContent> in_content)

Create a subsection with the given id, title, and content.

Parameters:

id - The ID

in_title - The title

in_content - The content

Returns:

A new subsection

subsectionTyped

public static SSubsection subsectionTyped(String type,
                                          SSubsectionTitle in_title,
                                          SNonEmptyList<SSubsectionContent> in_content)

Create a subsection with the given type, title, and content.

Parameters:

type - The type

in_title - The title

in_content - The content

Returns:

A new subsection

subsectionTypedID

public static SSubsection subsectionTypedID(String type,
                                            SID id,
                                            SSubsectionTitle in_title,
                                            SNonEmptyList<SSubsectionContent> in_content)

Create a subsection with the given type, id, title, and content.

Parameters:

type - The type

id - The ID

in_title - The title

in_content - The content

Returns:

A new subsection

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

equals in class Object

getContent

public SNonEmptyList<SSubsectionContent> getContent()

Returns:

The subsection content

getID

public com.io7m.jfunctional.OptionType<SID> getID()

Returns:

The subsection ID

getTitle

public SSubsectionTitle getTitle()

Returns:

The subsection title

getType

public com.io7m.jfunctional.OptionType<String> getType()

Returns:

The subsection type attribute

hashCode

public int hashCode()

Overrides:

hashCode in class Object