com.io7m.jstructural.core

Class SSectionWithSubsections

java.lang.Object

com.io7m.jstructural.core.SSection

com.io7m.jstructural.core.SSectionWithSubsections

@Immutable
public final class SSectionWithSubsections
extends SSection

The type of sections containing paragraphs.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
SNonEmptyList<SSubsection>	getSubsections()
int	hashCode()
static SSectionWithSubsections	section(SSectionTitle in_title, SNonEmptyList<SSubsection> in_content) Create a section with the given title and content.
<S> S	sectionAccept(SSectionVisitor<S> v) Accept a section visitor.
static SSectionWithSubsections	sectionID(SID id, SSectionTitle in_title, SNonEmptyList<SSubsection> in_content) Create a section with the given id, title, and content.
static SSectionWithSubsections	sectionTyped(String type, SSectionTitle in_title, SNonEmptyList<SSubsection> in_content) Create a section with the given type, title, and content.
static SSectionWithSubsections	sectionTypedID(String type, SID id, SSectionTitle in_title, SNonEmptyList<SSubsection> in_content) Create a section with the given type, id, title, and content.
static SSectionWithSubsections	sectionWithContents(SSectionTitle in_title, SNonEmptyList<SSubsection> in_content) Create a section with the given title, content, and with a table of contents.
static SSectionWithSubsections	sectionWithContentsID(SID id, SSectionTitle in_title, SNonEmptyList<SSubsection> in_content) Create a section with the given id, title, content, and with a table of contents.
static SSectionWithSubsections	sectionWithContentsTyped(String type, SSectionTitle in_title, SNonEmptyList<SSubsection> in_content) Create a section with the given type, title, content, and with a table of contents.
static SSectionWithSubsections	sectionWithContentsTypedID(String type, SID id, SSectionTitle in_title, SNonEmptyList<SSubsection> in_content) Create a section with the given type, id, title, content, and with a table of contents.

Methods inherited from class com.io7m.jstructural.core.SSection

getContents, getID, getTitle, getType

Methods inherited from class java.lang.Object

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

Method Detail

section

@Nonnull
public static SSectionWithSubsections section(@Nonnull
                                      SSectionTitle in_title,
                                      @Nonnull
                                      SNonEmptyList<SSubsection> in_content)
                                       throws com.io7m.jaux.Constraints.ConstraintError

Create a section with the given title and content.

Parameters:

in_title - The title

in_content - The content

Returns:

A new section

Throws:

com.io7m.jaux.Constraints.ConstraintError - If any parameter is null

sectionID

@Nonnull
public static SSectionWithSubsections sectionID(@Nonnull
                                        SID id,
                                        @Nonnull
                                        SSectionTitle in_title,
                                        @Nonnull
                                        SNonEmptyList<SSubsection> in_content)
                                         throws com.io7m.jaux.Constraints.ConstraintError

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

Parameters:

id - The ID

in_title - The title

in_content - The content

Returns:

A new section

Throws:

com.io7m.jaux.Constraints.ConstraintError - If any parameter is null

sectionTyped

@Nonnull
public static SSectionWithSubsections sectionTyped(@Nonnull
                                           String type,
                                           @Nonnull
                                           SSectionTitle in_title,
                                           @Nonnull
                                           SNonEmptyList<SSubsection> in_content)
                                            throws com.io7m.jaux.Constraints.ConstraintError

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

Parameters:

type - The type

in_title - The title

in_content - The content

Returns:

A new section

Throws:

com.io7m.jaux.Constraints.ConstraintError - If any parameter is null

sectionTypedID

@Nonnull
public static SSectionWithSubsections sectionTypedID(@Nonnull
                                             String type,
                                             @Nonnull
                                             SID id,
                                             @Nonnull
                                             SSectionTitle in_title,
                                             @Nonnull
                                             SNonEmptyList<SSubsection> in_content)
                                              throws com.io7m.jaux.Constraints.ConstraintError

Create a section 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 section

Throws:

com.io7m.jaux.Constraints.ConstraintError - If any parameter is null

sectionWithContents

@Nonnull
public static SSectionWithSubsections sectionWithContents(@Nonnull
                                                  SSectionTitle in_title,
                                                  @Nonnull
                                                  SNonEmptyList<SSubsection> in_content)
                                                   throws com.io7m.jaux.Constraints.ConstraintError

Create a section with the given title, content, and with a table of contents.

Parameters:

in_title - The title

in_content - The content

Returns:

A new section

Throws:

com.io7m.jaux.Constraints.ConstraintError - If any parameter is null

sectionWithContentsID

@Nonnull
public static SSectionWithSubsections sectionWithContentsID(@Nonnull
                                                    SID id,
                                                    @Nonnull
                                                    SSectionTitle in_title,
                                                    @Nonnull
                                                    SNonEmptyList<SSubsection> in_content)
                                                     throws com.io7m.jaux.Constraints.ConstraintError

Create a section with the given id, title, content, and with a table of contents.

Parameters:

id - The ID

in_title - The title

in_content - The content

Returns:

A new section

Throws:

com.io7m.jaux.Constraints.ConstraintError - If any parameter is null

sectionWithContentsTyped

@Nonnull
public static SSectionWithSubsections sectionWithContentsTyped(@Nonnull
                                                       String type,
                                                       @Nonnull
                                                       SSectionTitle in_title,
                                                       @Nonnull
                                                       SNonEmptyList<SSubsection> in_content)
                                                        throws com.io7m.jaux.Constraints.ConstraintError

Create a section with the given type, title, content, and with a table of contents.

Parameters:

type - The type

in_title - The title

in_content - The content

Returns:

A new section

Throws:

com.io7m.jaux.Constraints.ConstraintError - If any parameter is null

sectionWithContentsTypedID

@Nonnull
public static SSectionWithSubsections sectionWithContentsTypedID(@Nonnull
                                                         String type,
                                                         @Nonnull
                                                         SID id,
                                                         @Nonnull
                                                         SSectionTitle in_title,
                                                         @Nonnull
                                                         SNonEmptyList<SSubsection> in_content)
                                                          throws com.io7m.jaux.Constraints.ConstraintError

Create a section with the given type, id, title, content, and with a table of contents.

Parameters:

type - The type

id - The ID

in_title - The title

in_content - The content

Returns:

A new section

Throws:

com.io7m.jaux.Constraints.ConstraintError - If any parameter is null

equals

public boolean equals(Object obj)

Overrides:

equals in class SSection

getSubsections

@Nonnull
public SNonEmptyList<SSubsection> getSubsections()

Returns:

The section content

hashCode

public int hashCode()

Overrides:

hashCode in class SSection

sectionAccept

public <S> S sectionAccept(@Nonnull
                  SSectionVisitor<S> v)
                throws com.io7m.jaux.Constraints.ConstraintError,
                       Exception

Description copied from class: SSection

Accept a section visitor.

Specified by:

sectionAccept in class SSection

Type Parameters:

S - The type of transformed SSections

Parameters:

v - The visitor

Returns:

The value returned by the visitor

Throws:

com.io7m.jaux.Constraints.ConstraintError - If the visitor raises Constraints.ConstraintError

Exception - If the visitor raises an Exception