com.io7m.jstructural.annotated

Class SADocumentTitle

java.lang.Object

com.io7m.jstructural.annotated.SADocumentTitle

@Immutable
public final class SADocumentTitle
extends Object

A document title.

Method Summary

Methods

Modifier and Type	Method and Description
static SADocumentTitle	documentTitle(String actual) Construct a document title.
boolean	equals(Object obj)
String	getActual()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

documentTitle

@Nonnull
public static SADocumentTitle documentTitle(@Nonnull
                                    String actual)
                                     throws com.io7m.jaux.Constraints.ConstraintError

Construct a document title.

Parameters:

actual - The text

Returns:

A new document title

Throws:

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getActual

@Nonnull
public String getActual()

Returns:

The text

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object