com.io7m.jstructural.core

Class SFormalItemList

java.lang.Object

com.io7m.jstructural.core.SFormalItemList

All Implemented Interfaces:

SFormalItemContent, SParagraphContent

@Immutable
public final class SFormalItemList
extends Object
implements SFormalItemContent, SParagraphContent

A list of formal items of a given kind.

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.
static SFormalItemList	formalItemList(String kind) Construct a formal item list.
String	getKind()
int	hashCode()
<A> A	paragraphContentAccept(SParagraphContentVisitor<A> v) Accept a paragraph content visitor.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

formalItemList

@Nonnull
public static SFormalItemList formalItemList(@Nonnull
                                     String kind)
                                      throws com.io7m.jaux.Constraints.ConstraintError

Construct a formal item list.

Parameters:

kind - The kind of formal items

Returns:

A new formal item list

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

getKind

@Nonnull
public String getKind()

Returns:

The kind of formal items

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

toString

public String toString()

Overrides:

toString in class Object