com.io7m.jstructural.annotated

Class SASectionTitle

java.lang.Object

com.io7m.jstructural.annotated.SASectionTitle

@Immutable
public final class SASectionTitle
extends Object

A section title.

Constructor Summary

Constructors

Constructor and Description
SASectionTitle(SASectionNumber in_number, String in_actual) Construct a new section title.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getActual()
SASectionNumber	getNumber()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SASectionTitle

public SASectionTitle(@Nonnull
              SASectionNumber in_number,
              @Nonnull
              String in_actual)
               throws com.io7m.jaux.Constraints.ConstraintError

Construct a new section title.

Parameters:

in_number - The section number

in_actual - The section title

Throws:

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

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getActual

@Nonnull
public String getActual()

Returns:

The text

getNumber

@Nonnull
public SASectionNumber getNumber()

Returns:

The number

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object