com.speedment.runtime.config.trait

Interface HasOrdinalPosition

All Superinterfaces:

Document

All Known Subinterfaces:

Column, ForeignKeyColumn, IndexColumn, PrimaryKeyColumn

public interface HasOrdinalPosition
extends Document

Trait for Document implementations that implement the getOrdinalPosition() method.

Version:

2.3.0

Author:

Emil Forslund

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<HasOrdinalPosition>	COMPARATOR The default Comparator used for documents that implement the HasOrdinalPosition trait.
static String	ORDINAL_POSITION The key of the ordinalPosition property.

Method Summary

Modifier and Type	Method and Description
default int	getOrdinalPosition() Returns the position to use when ordering this node.
static HasOrdinalPosition	of(Document document) Returns a wrapper of the specified document that implements the HasOrdinalPosition trait.

Methods inherited from interface com.speedment.runtime.config.Document

ancestors, children, children, get, getAsBoolean, getAsDouble, getAsInt, getAsLong, getAsString, getData, getParent, put

Field Detail

ORDINAL_POSITION

static final String ORDINAL_POSITION

The key of the ordinalPosition property.

See Also:

Constant Field Values

COMPARATOR

static final Comparator<HasOrdinalPosition> COMPARATOR

The default Comparator used for documents that implement the HasOrdinalPosition trait. This will simply order the elements based on the natural ordering of their getOrdinalPosition() result.

Method Detail

getOrdinalPosition

default int getOrdinalPosition()

Returns the position to use when ordering this node.

Returns:

the ordinal position.

of

static HasOrdinalPosition of(Document document)

Returns a wrapper of the specified document that implements the HasOrdinalPosition trait. If the specified document already implements the trait, it is returned unwrapped.

Parameters:

document - the document to wrap

Returns:

the wrapper