com.io7m.jstructural.core.SVerbatim 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 verbatim text element.
 */

public final class SVerbatim implements
  SFootnoteContent,
  SListItemContent,
  SParagraphContent,
  SFormalItemContent,
  STableCellContent
{
  /**
   * Construct a new verbatim element with the given text.
   * 
   * @param text
   *          The text
   * @return A new term
   */

  public static SVerbatim verbatim(
    final String text)
  {
    final OptionType none = Option.none();
    return new SVerbatim(text, none);
  }

  /**
   * Construct a new verbatim element with the given text and type attribute.
   * 
   * @param text
   *          The text
   * @param type
   *          The type attribute
   * @return A new term
   */

  public static SVerbatim verbatimTyped(
    final String text,
    final String type)
  {
    final OptionType some =
      Option.some(NullCheck.notNull(type, "Type"));
    return new SVerbatim(text, some);
  }

  private final String             text;
  private final OptionType type;

  private SVerbatim(
    final String in_text,
    final OptionType in_type)
  {
    this.text = NullCheck.notNull(in_text, "Text");
    this.type = NullCheck.notNull(in_type, "Type");
  }

  @Override public boolean equals(
    final @Nullable Object obj)
  {
    if (this == obj) {
      return true;
    }
    if (obj == null) {
      return false;
    }
    if (this.getClass() != obj.getClass()) {
      return false;
    }
    final SVerbatim other = (SVerbatim) obj;
    return this.text.equals(other.text) && this.type.equals(other.type);
  }

  @Override public  A footnoteContentAccept(
    final SFootnoteContentVisitor v)
    throws Exception
  {
    return v.visitVerbatim(this);
  }

  @Override public  A formalItemContentAccept(
    final SFormalItemContentVisitor v)
    throws Exception
  {
    return v.visitVerbatim(this);
  }

  /**
   * @return The term's text
   */

  public String getText()
  {
    return this.text;
  }

  /**
   * @return The term's type attribute
   */

  public OptionType getType()
  {
    return this.type;
  }

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

  @Override public  A listItemContentAccept(
    final SListItemContentVisitor v)
    throws Exception
  {
    return v.visitVerbatim(this);
  }

  @Override public  A paragraphContentAccept(
    final SParagraphContentVisitor v)
    throws Exception
  {
    return v.visitVerbatim(this);
  }

  @Override public  A tableCellContentAccept(
    final STableCellContentVisitor v)
    throws Exception
  {
    return v.visitVerbatim(this);
  }
}