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

import com.io7m.jfunctional.OptionType;

/**
 * Readable interface to the set of segments in the given document.
 */

public interface SASegmentsReadable
{
  /**
   * @return The number of the first segment
   */

  SASegmentNumber segmentGetFirst();

  /**
   * @param n
   *          The current segment
   * @return The number of the next segment (if any)
   */

  OptionType segmentGetNext(
    final SASegmentNumber n);

  /**
   * @param n
   *          The current segment
   * @return The number of the previous segment (if any)
   */

  OptionType segmentGetPrevious(
    final SASegmentNumber n);

  /**
   * @param n
   *          The current segment
   * @return The number of the parent segment (if any)
   */

  OptionType segmentGetUp(
    final SASegmentNumber n);
}