com.io7m.jstructural.annotated.SAParagraphContentVisitor 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.annotated;

/**
 * Paragraph content visitor.
 * 
 * @param 
 *          The type of values returned by the visitor
 */

public interface SAParagraphContentVisitor
{
  /**
   * Visit a footnote element.
   * 
   * @param footnote
   *          The footnote element
   * @return A value of type A
   * 
   * @throws Exception
   *           If required
   */

  A visitFootnote(
    final SAFootnote footnote)
    throws Exception;

  /**
   * Visit a formal item list element.
   * 
   * @param list
   *          The formal item list element
   * @return A value of type A
   * 
   * @throws Exception
   *           If required
   */

  A visitFormalItemList(
    final SAFormalItemList list)
    throws Exception;

  /**
   * Visit an image element.
   * 
   * @param image
   *          The image element
   * @return A value of type A
   * 
   * @throws Exception
   *           If required
   */

  A visitImage(
    final SAImage image)
    throws Exception;

  /**
   * Visit a link element.
   * 
   * @param link
   *          The link element
   * @return A value of type A
   * 
   * @throws Exception
   *           If required
   */

  A visitLink(
    final SALink link)
    throws Exception;

  /**
   * Visit a link element.
   * 
   * @param link
   *          The link element
   * @return A value of type A
   * 
   * @throws Exception
   *           If required
   */

  A visitLinkExternal(
    final SALinkExternal link)
    throws Exception;

  /**
   * Visit an ordered list element.
   * 
   * @param list
   *          The list element
   * @return A value of type A
   * 
   * @throws Exception
   *           If required
   */

  A visitListOrdered(
    final SAListOrdered list)
    throws Exception;

  /**
   * Visit an unordered list element.
   * 
   * @param list
   *          The list element
   * @return A value of type A
   * 
   * @throws Exception
   *           If required
   */

  A visitListUnordered(
    final SAListUnordered list)
    throws Exception;

  /**
   * Visit a table element.
   * 
   * @param table
   *          The table element
   * @return A value of type A
   * 
   * @throws Exception
   *           If required
   */

  A visitTable(
    final SATable table)
    throws Exception;

  /**
   * Visit a term element.
   * 
   * @param term
   *          The term element
   * @return A value of type A
   * 
   * @throws Exception
   *           If required
   */

  A visitTerm(
    final SATerm term)
    throws Exception;

  /**
   * Visit a text element.
   * 
   * @param text
   *          The text element
   * @return A value of type A
   * 
   * @throws Exception
   *           If required
   */

  A visitText(
    final SAText text)
    throws Exception;

  /**
   * Visit a verbatim element.
   * 
   * @param text
   *          The verbatim element
   * @return A value of type A
   * 
   * @throws Exception
   *           If required
   */

  A visitVerbatim(
    final SAVerbatim text)
    throws Exception;
}