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

/**
 * An abstract paragraph number.
 */

public abstract class SAParagraphNumber implements
  Comparable,
  SASubsectionContentNumber
{
  /**
   * @return The paragraph number
   */

  public abstract int getParagraph();

  /**
   * Accept a paragraph number visitor.
   * 
   * @param 
   *          The type of values returned by the visitor
   * @param v
   *          The visitor
   * @return The value returned by the visitor
   * 
   * @throws Exception
   *           If the visitor raises an {@link Exception}
   */

  public abstract  T paragraphNumberAccept(
    final SAParagraphNumberVisitor v)
    throws Exception;

  /**
   * @return A human-readable string representing the paragraph number (such
   *         as "1.2.3.4")
   */

  public abstract String paragraphNumberFormat();

  @Override public final  T subsectionContentNumberAccept(
    final SASubsectionContentNumberVisitor v)
    throws Exception
  {
    return v.visitParagraphNumber(this);
  }
}