com.io7m.jstructural.core

Class SListOrdered

java.lang.Object

com.io7m.jstructural.core.SListOrdered

All Implemented Interfaces:

SFootnoteContent, SFormalItemContent, SListItemContent, SParagraphContent, STableCellContent

@Immutable
public final class SListOrdered
extends Object
implements SListItemContent, SFootnoteContent, SParagraphContent, SFormalItemContent, STableCellContent

An ordered list element.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
<A> A	footnoteContentAccept(SFootnoteContentVisitor<A> v) Accept a footnote content visitor.
<A> A	formalItemContentAccept(SFormalItemContentVisitor<A> v) Accept a formal item content visitor.
SNonEmptyList<SListItem>	getItems()
com.io7m.jaux.functional.Option<String>	getType()
int	hashCode()
static SListOrdered	list(SNonEmptyList<SListItem> content) Construct a new list.
<A> A	listItemContentAccept(SListItemContentVisitor<A> v) Accept a list item content visitor.
static SListOrdered	listTyped(String type, SNonEmptyList<SListItem> content) Construct a new list item with a type attribute.
<A> A	paragraphContentAccept(SParagraphContentVisitor<A> v) Accept a paragraph content visitor.
<A> A	tableCellContentAccept(STableCellContentVisitor<A> v) Accept a table cell content visitor.

Methods inherited from class java.lang.Object

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

Method Detail

list

@Nonnull
public static SListOrdered list(@Nonnull
                        SNonEmptyList<SListItem> content)
                         throws com.io7m.jaux.Constraints.ConstraintError

Construct a new list.

Parameters:

content - The list content.

Returns:

A new list

Throws:

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

listTyped

@Nonnull
public static SListOrdered listTyped(@Nonnull
                             String type,
                             @Nonnull
                             SNonEmptyList<SListItem> content)
                              throws com.io7m.jaux.Constraints.ConstraintError

Construct a new list item with a type attribute.

Parameters:

type - The type attribute

content - The list content.

Returns:

A new list

Throws:

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

footnoteContentAccept

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

Description copied from interface: SFootnoteContent

Accept a footnote content visitor.

Specified by:

footnoteContentAccept in interface SFootnoteContent

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

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

getItems

@Nonnull
public SNonEmptyList<SListItem> getItems()

Returns:

The list items

getType

@Nonnull
public com.io7m.jaux.functional.Option<String> getType()

Returns:

The type attribute

hashCode

public int hashCode()

Overrides:

hashCode in class Object

listItemContentAccept

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

Description copied from interface: SListItemContent

Accept a list item content visitor.

Specified by:

listItemContentAccept in interface SListItemContent

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

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

tableCellContentAccept

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

Description copied from interface: STableCellContent

Accept a table cell content visitor.

Specified by:

tableCellContentAccept in interface STableCellContent

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