com.io7m.jstructural.core

Class SListItem

java.lang.Object

com.io7m.jstructural.core.SListItem

@Immutable
public final class SListItem
extends Object

A list item element.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
SNonEmptyList<SListItemContent>	getContent()
com.io7m.jaux.functional.Option<String>	getType()
int	hashCode()
static SListItem	listItem(SNonEmptyList<SListItemContent> content) Construct a new list item.
static SListItem	listItemTyped(String type, SNonEmptyList<SListItemContent> content) Construct a new list item with a type attribute.

Methods inherited from class java.lang.Object

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

Method Detail

listItem

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

Construct a new list item.

Parameters:

content - The list item content.

Returns:

A new list item

Throws:

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

listItemTyped

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

Construct a new list item with a type attribute.

Parameters:

type - The type attribute

content - The list item content.

Returns:

A new list item

Throws:

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getContent

@Nonnull
public SNonEmptyList<SListItemContent> getContent()

Returns:

The element content

getType

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

Returns:

The type attribute

hashCode

public int hashCode()

Overrides:

hashCode in class Object