com.io7m.jstructural.core

Class STable

java.lang.Object

com.io7m.jstructural.core.STable

All Implemented Interfaces:

SFormalItemContent, SParagraphContent

public final class STable
extends Object
implements SFormalItemContent, SParagraphContent

A table.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
<A> A	formalItemContentAccept(SFormalItemContentVisitor<A> v) Accept a formal item content visitor.
STableBody	getBody()
com.io7m.jaux.functional.Option<STableHead>	getHeader()
STableSummary	getSummary()
int	hashCode()
<A> A	paragraphContentAccept(SParagraphContentVisitor<A> v) Accept a paragraph content visitor.
static STable	table(STableSummary in_summary, STableBody in_body) Construct a new table with the given summary and body.
static STable	tableHeader(STableSummary in_summary, STableHead in_head, STableBody in_body) Construct a new table with the given summary, header, and body.

Methods inherited from class java.lang.Object

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

Method Detail

table

@Nonnull
public static STable table(@Nonnull
                   STableSummary in_summary,
                   @Nonnull
                   STableBody in_body)
                    throws com.io7m.jaux.Constraints.ConstraintError

Construct a new table with the given summary and body.

Parameters:

in_summary - The summary

in_body - The body

Returns:

A new table

Throws:

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

tableHeader

@Nonnull
public static STable tableHeader(@Nonnull
                         STableSummary in_summary,
                         @Nonnull
                         STableHead in_head,
                         @Nonnull
                         STableBody in_body)
                          throws com.io7m.jaux.Constraints.ConstraintError

Construct a new table with the given summary, header, and body.

Parameters:

in_head - The header

in_summary - The summary

in_body - The body

Returns:

A new table

Throws:

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

formalItemContentAccept

public <A> A formalItemContentAccept(@Nonnull
                            SFormalItemContentVisitor<A> v)
                          throws com.io7m.jaux.Constraints.ConstraintError,
                                 Exception

Description copied from interface: SFormalItemContent

Accept a formal item content visitor.

Specified by:

formalItemContentAccept in interface SFormalItemContent

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 a Constraints.ConstraintError

Exception - If the visitor raises and Exception

getBody

@Nonnull
public STableBody getBody()

Returns:

The table body

getHeader

@Nonnull
public com.io7m.jaux.functional.Option<STableHead> getHeader()

Returns:

The table header

getSummary

@Nonnull
public STableSummary getSummary()

Returns:

The table summary

hashCode

public int hashCode()

Overrides:

hashCode in class Object

paragraphContentAccept

public <A> A paragraphContentAccept(@Nonnull
                           SParagraphContentVisitor<A> v)
                         throws com.io7m.jaux.Constraints.ConstraintError,
                                Exception

Description copied from interface: SParagraphContent

Accept a paragraph content visitor.

Specified by:

paragraphContentAccept in interface SParagraphContent

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 a Constraints.ConstraintError

Exception - If the visitor raises and Exception