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

    All Methods Static Methods Instance Methods Concrete 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

          public static SSectionWithSubsections section(SSectionTitle in_title,
                                                        SNonEmptyList<SSubsection> in_content)

      Create a section with the given title and content.
      Parameters:
        `in_title` - The title
        `in_content` - The content
      Returns:
        A new section

    - #### sectionID

          public static SSectionWithSubsections sectionID(SID id,
                                                          SSectionTitle in_title,
                                                          SNonEmptyList<SSubsection> in_content)

      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

    - #### sectionTyped

          public static SSectionWithSubsections sectionTyped(String type,
                                                             SSectionTitle in_title,
                                                             SNonEmptyList<SSubsection> in_content)

      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

    - #### sectionTypedID

          public 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.
      Parameters:
        `type` - The type
        `id` - The ID
        `in_title` - The title
        `in_content` - The content
      Returns:
        A new section

    - #### sectionWithContents

          public static SSectionWithSubsections sectionWithContents(SSectionTitle in_title,
                                                                    SNonEmptyList<SSubsection> in_content)

      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

    - #### sectionWithContentsID

          public 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.
      Parameters:
        `id` - The ID
        `in_title` - The title
        `in_content` - The content
      Returns:
        A new section

    - #### sectionWithContentsTyped

          public 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.
      Parameters:
        `type` - The type
        `in_title` - The title
        `in_content` - The content
      Returns:
        A new section

    - #### sectionWithContentsTypedID

          public 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.
      Parameters:
        `type` - The type
        `id` - The ID
        `in_title` - The title
        `in_content` - The content
      Returns:
        A new section

    - #### equals

          public boolean equals(@Nullable
                                Object obj)

      Overrides:
        `equals` in class `SSection`

    - #### getSubsections

          public SNonEmptyList<SSubsection> getSubsections()

      Returns:
        The section content

    - #### hashCode

          public int hashCode()

      Overrides:
        `hashCode` in class `SSection`

    - #### sectionAccept

          public <S> S sectionAccept(SSectionVisitor<S> v)
                              throws Exception

      Description copied from class: `SSection`
      Accept a section visitor.
      Specified by:
        `sectionAccept` in class `SSection`
      Type Parameters:
        `S` - The type of transformed `SSection`s
      Parameters:
        `v` - The visitor
      Returns:
        The value returned by the visitor
      Throws:
        `Exception` - If the visitor raises an `Exception`

Copyright © 2015 <code@io7m.com> http://io7m.com