com.io7m.jstructural.annotated

Class SADocument

java.lang.Object

com.io7m.jstructural.annotated.SADocument

All Implemented Interfaces:

SASegmentsReadable

Direct Known Subclasses:

SADocumentWithParts, SADocumentWithSections

public abstract class SADocument
extends Object
implements SASegmentsReadable

A document.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SADocument(SAIDMap in_ids, SADocumentTitle in_title, com.io7m.jaux.functional.Option<SDocumentContents> in_contents, com.io7m.jaux.functional.Option<SDocumentStyle> in_style, List<SAFootnote> in_footnotes, SAFormalItemsByKind in_formals)

Method Summary

Methods

Modifier and Type	Method and Description
abstract <A> A	documentAccept(SADocumentVisitor<A> v) Accept a document visitor.
boolean	equals(Object obj)
com.io7m.jaux.functional.Option<SDocumentContents>	getContents()
List<SAFootnote>	getFootnotes()
SAFormalItemsByKindReadable	getFormals()
SAIDMapReadable	getIDMappings()
abstract com.io7m.jaux.functional.Option<SASection>	getSection(SASectionNumber n)
com.io7m.jaux.functional.Option<SDocumentStyle>	getStyle()
SADocumentTitle	getTitle()
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.io7m.jstructural.annotated.SASegmentsReadable

segmentGetFirst, segmentGetNext, segmentGetPrevious, segmentGetUp

Constructor Detail

SADocument

protected SADocument(@Nonnull
          SAIDMap in_ids,
          @Nonnull
          SADocumentTitle in_title,
          @Nonnull
          com.io7m.jaux.functional.Option<SDocumentContents> in_contents,
          @Nonnull
          com.io7m.jaux.functional.Option<SDocumentStyle> in_style,
          @Nonnull
          List<SAFootnote> in_footnotes,
          @Nonnull
          SAFormalItemsByKind in_formals)
              throws com.io7m.jaux.Constraints.ConstraintError

Throws:

com.io7m.jaux.Constraints.ConstraintError

Method Detail

documentAccept

public abstract <A> A documentAccept(@Nonnull
                   SADocumentVisitor<A> v)
                          throws com.io7m.jaux.Constraints.ConstraintError,
                                 Exception

Accept a document visitor.

Type Parameters:

A - The type of values returned by the visitor

Parameters:

v - The visitor

Returns:

The value returned by the visitor

Throws:

com.io7m.jaux.Constraints.ConstraintError - If the visitor raises Constraints.ConstraintError

Exception - If the visitor raises an Exception

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getContents

@Nonnull
public final com.io7m.jaux.functional.Option<SDocumentContents> getContents()

Returns:

The document contents

getFootnotes

@Nonnull
public final List<SAFootnote> getFootnotes()

Returns:

The document's footnotes

getFormals

@Nonnull
public final SAFormalItemsByKindReadable getFormals()

Returns:

The formal items by kind

getIDMappings

@Nonnull
public final SAIDMapReadable getIDMappings()

Returns:

The set of mappings from IDs to elements

getSection

public abstract com.io7m.jaux.functional.Option<SASection> getSection(@Nonnull
                                                    SASectionNumber n)
                                                               throws com.io7m.jaux.Constraints.ConstraintError

Parameters:

n - The section number

Returns:

The section with the given section number, if any.

Throws:

com.io7m.jaux.Constraints.ConstraintError - If any parameter is null

getStyle

@Nonnull
public final com.io7m.jaux.functional.Option<SDocumentStyle> getStyle()

Returns:

The document style

getTitle

@Nonnull
public final SADocumentTitle getTitle()

Returns:

The document title

hashCode

public int hashCode()

Overrides:

hashCode in class Object