com.io7m.jstructural.annotated

Class SAImage

java.lang.Object

com.io7m.jstructural.annotated.SAImage

All Implemented Interfaces:

SAFootnoteContent, SAFormalItemContent, SALinkContent, SAListItemContent, SAParagraphContent, SATableCellContent

@Immutable
public final class SAImage
extends Object
implements SAParagraphContent, SALinkContent, SAListItemContent, SAFootnoteContent, SAFormalItemContent, SATableCellContent

An image.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
<A> A	footnoteContentAccept(SAFootnoteContentVisitor<A> v) Accept a footnote content visitor.
<A> A	formalItemContentAccept(SAFormalItemContentVisitor<A> v) Accept a formal item content visitor.
com.io7m.jaux.functional.Option<Integer>	getHeight()
String	getText()
com.io7m.jaux.functional.Option<String>	getType()
URI	getURI()
com.io7m.jaux.functional.Option<Integer>	getWidth()
int	hashCode()
<A> A	linkContentAccept(SALinkContentVisitor<A> v) Accept a link content visitor.
<A> A	listItemContentAccept(SAListItemContentVisitor<A> v) Accept a list item content visitor.
<A> A	paragraphContentAccept(SAParagraphContentVisitor<A> v) Accept a paragraph content visitor.
<A> A	tableCellContentAccept(SATableCellContentVisitor<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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

footnoteContentAccept

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

Description copied from interface: SAFootnoteContent

Accept a footnote content visitor.

Specified by:

footnoteContentAccept in interface SAFootnoteContent

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
                            SAFormalItemContentVisitor<A> v)
                          throws com.io7m.jaux.Constraints.ConstraintError,
                                 Exception

Description copied from interface: SAFormalItemContent

Accept a formal item content visitor.

Specified by:

formalItemContentAccept in interface SAFormalItemContent

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

getHeight

@Nonnull
public com.io7m.jaux.functional.Option<Integer> getHeight()

Returns:

The image height specified, if any

getText

@Nonnull
public String getText()

Returns:

The image text

getType

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

Returns:

The term's type attribute

getURI

@Nonnull
public URI getURI()

Returns:

The image URI

getWidth

@Nonnull
public com.io7m.jaux.functional.Option<Integer> getWidth()

Returns:

The image width specified, if any

hashCode

public int hashCode()

Overrides:

hashCode in class Object

linkContentAccept

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

Description copied from interface: SALinkContent

Accept a link content visitor.

Specified by:

linkContentAccept in interface SALinkContent

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

listItemContentAccept

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

Description copied from interface: SAListItemContent

Accept a list item content visitor.

Specified by:

listItemContentAccept in interface SAListItemContent

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
                           SAParagraphContentVisitor<A> v)
                         throws com.io7m.jaux.Constraints.ConstraintError,
                                Exception

Description copied from interface: SAParagraphContent

Accept a paragraph content visitor.

Specified by:

paragraphContentAccept in interface SAParagraphContent

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
                           SATableCellContentVisitor<A> v)
                         throws com.io7m.jaux.Constraints.ConstraintError,
                                Exception

Description copied from interface: SATableCellContent

Accept a table cell content visitor.

Specified by:

tableCellContentAccept in interface SATableCellContent

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