com.io7m.jstructural.core.SDocumentWithSections Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of io7m-jstructural-core Show documentation
Java implementation of the structural document language (Core types)
There is a newer version: 5.0.0
Show newest version
/*
 * Copyright © 2014  http://io7m.com
 * 
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
 * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

package com.io7m.jstructural.core;

import com.io7m.jfunctional.Option;
import com.io7m.jfunctional.OptionType;
import com.io7m.jnull.NullCheck;
import com.io7m.jnull.Nullable;

/**
 * A document with sections.
 */

public final class SDocumentWithSections extends SDocument
{
  /**
   * Construct a new document with the given title, and style.
   * 
   * @param in_title
   *          The title
   * @param in_content
   *          The sections
   * @return A new document
   */

  public static SDocumentWithSections document(
    final SDocumentTitle in_title,
    final SNonEmptyList in_content)
  {
    final OptionType some_contents = Option.none();
    final OptionType some_style = Option.none();
    return new SDocumentWithSections(
      in_title,
      some_contents,
      some_style,
      in_content);
  }

  /**
   * Construct a new document with the given title, and table of contents.
   * 
   * @param in_title
   *          The title
   * @param in_content
   *          The sections
   * @return A new document
   */

  public static SDocumentWithSections documentContents(
    final SDocumentTitle in_title,
    final SNonEmptyList in_content)
  {
    final OptionType some_contents =
      Option.some(SDocumentContents.get());
    final OptionType some_style = Option.none();
    return new SDocumentWithSections(
      in_title,
      some_contents,
      some_style,
      in_content);
  }

  /**
   * Construct a new document with the given title.
   * 
   * @param in_title
   *          The title
   * @param in_style
   *          The style
   * @param in_content
   *          The sections
   * @return A new document
   */

  public static SDocumentWithSections documentStyle(
    final SDocumentTitle in_title,
    final SDocumentStyle in_style,
    final SNonEmptyList in_content)
  {
    final OptionType some_contents = Option.none();
    final OptionType some_style =
      Option.some(NullCheck.notNull(in_style, "Style"));
    return new SDocumentWithSections(
      in_title,
      some_contents,
      some_style,
      in_content);
  }

  /**
   * Construct a new document with the given title, style, and table of
   * contents.
   * 
   * @param in_title
   *          The title
   * @param in_style
   *          The style
   * @param in_content
   *          The sections
   * @return A new document
   */

  public static SDocumentWithSections documentStyleContents(
    final SDocumentTitle in_title,
    final SDocumentStyle in_style,
    final SNonEmptyList in_content)
  {
    final OptionType some_contents =
      Option.some(SDocumentContents.get());
    final OptionType some_style =
      Option.some(NullCheck.notNull(in_style, "Style"));
    return new SDocumentWithSections(
      in_title,
      some_contents,
      some_style,
      in_content);
  }

  private final SNonEmptyList sections;

  private SDocumentWithSections(
    final SDocumentTitle in_title,
    final OptionType in_contents,
    final OptionType in_style,
    final SNonEmptyList in_content)
  {
    super(in_title, in_contents, in_style);
    this.sections = NullCheck.notNull(in_content, "Content");
  }

  @Override public  D documentAccept(
    final SDocumentVisitor v)
    throws Exception
  {
    return v.visitDocumentWithSections(this);
  }

  @Override public boolean equals(
    final @Nullable Object obj)
  {
    if (this == obj) {
      return true;
    }
    if (!super.equals(obj)) {
      return false;
    }
    if (obj == null) {
      return false;
    }
    if (this.getClass() != obj.getClass()) {
      return false;
    }
    final SDocumentWithSections other = (SDocumentWithSections) obj;
    return this.sections.equals(other.sections);
  }

  /**
   * @return The document sections
   */

  public SNonEmptyList getSections()
  {
    return this.sections;
  }

  @Override public int hashCode()
  {
    final int prime = 31;
    int result = super.hashCode();
    result = (prime * result) + this.sections.hashCode();
    return result;
  }
}