com.io7m.jstructural.core.SFootnote 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.jnull.NullCheck;
import com.io7m.jnull.Nullable;

/**
 * A footnote element.
 */

public final class SFootnote implements
  SParagraphContent,
  SListItemContent,
  SFootnoteContent,
  STableCellContent
{
  /**
   * Construct a new footnote.
   * 
   * @param content
   *          The footnote content.
   * @return A new footnote
   */

  public static SFootnote footnote(
    final SNonEmptyList content)
  {
    return new SFootnote(content);
  }

  private final SNonEmptyList content;

  private SFootnote(
    final SNonEmptyList in_content)
  {
    this.content = NullCheck.notNull(in_content, "Content");
  }

  @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 SFootnote other = (SFootnote) obj;
    return this.content.equals(other.content);
  }

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

  /**
   * @return The element content
   */

  public SNonEmptyList getContent()
  {
    return this.content;
  }

  @Override public int hashCode()
  {
    return this.content.hashCode();
  }

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

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

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