com.io7m.jstructural.core

## Class SSection

- java.lang.Object
- - com.io7m.jstructural.core.SSection

- Direct Known Subclasses:
    SSectionWithParagraphs, SSectionWithSubsections

      @Immutable
      public abstract class SSection
      extends Object

  An abstract section.

- - ### Constructor Summary

    Constructors
    Modifier | Constructor and Description
    --- | ---
    `protected` | `SSection(com.io7m.jfunctional.OptionType<String> in_type, com.io7m.jfunctional.OptionType<SID> in_id, SSectionTitle in_title, com.io7m.jfunctional.OptionType<SSectionContents> in_contents)`

  - ### Method Summary

    All Methods Instance Methods Abstract Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `equals(Object obj)`
    `com.io7m.jfunctional.OptionType<SSectionContents>` | `getContents()`
    `com.io7m.jfunctional.OptionType<SID>` | `getID()`
    `SSectionTitle` | `getTitle()`
    `com.io7m.jfunctional.OptionType<String>` | `getType()`
    `int` | `hashCode()`
    `abstract <S> S` | `sectionAccept(SSectionVisitor<S> v)` Accept a section visitor.

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### SSection

          protected SSection(com.io7m.jfunctional.OptionType<String> in_type,
                             com.io7m.jfunctional.OptionType<SID> in_id,
                             SSectionTitle in_title,
                             com.io7m.jfunctional.OptionType<SSectionContents> in_contents)

  - ### Method Detail

    - #### equals

          public boolean equals(@Nullable
                                Object obj)

      Overrides:
        `equals` in class `Object`

    - #### getContents

          public final com.io7m.jfunctional.OptionType<SSectionContents> getContents()

      Returns:
        The section contents

    - #### getID

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

      Returns:
        The section ID

    - #### getTitle

          public final SSectionTitle getTitle()

      Returns:
        The section title

    - #### getType

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

      Returns:
        The section type attribute

    - #### hashCode

          public int hashCode()

      Overrides:
        `hashCode` in class `Object`

    - #### sectionAccept

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

      Accept a section visitor.
      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