Module dev.metaschema.core

Package dev.metaschema.core.metapath.item.atomic

Interface ITokenItem

All Superinterfaces:

IAnyAtomicItem, IAtomicValuedItem, ICollectionValue, IItem, IStringItem

public interface ITokenItem
extends IStringItem

An atomic Metapath item containing a text token data value.

Method Summary

Modifier and Type	Method	Description
static ITokenItem	cast(IAnyAtomicItem item)	Cast the provided type to this item type.
default ITokenItem	castAsType(IAnyAtomicItem item)	Cast the provided item to be the same type as this item.
default IAtomicOrUnionType<ITokenItem>	getType()	Get the type information for the item.
static IAtomicOrUnionType<ITokenItem>	type()	Get the type information for this item.
static ITokenItem	valueOf(String value)	Construct a new item using the provided string value.

Methods inherited from interface dev.metaschema.core.metapath.item.atomic.IAnyAtomicItem

accept, asMapKey, asString, atomize, deepEquals, getJavaTypeAdapter, getValue, toAtomicItem

Methods inherited from interface dev.metaschema.core.metapath.item.ICollectionValue

deepEquals, toSignature

Methods inherited from interface dev.metaschema.core.metapath.item.IItem

contentsAsSequence, flatten, hasValue, toSequence

Methods inherited from interface dev.metaschema.core.metapath.item.atomic.IStringItem

asStringItem, compareTo, encode, length, normalizeSpace

Method Details

type

@NonNull
static IAtomicOrUnionType<ITokenItem> type()

Get the type information for this item.

Returns:

the type information

getType

default IAtomicOrUnionType<ITokenItem> getType()

Description copied from interface: IItem

Get the type information for the item.

Specified by:

getType in interface IItem

Specified by:

getType in interface IStringItem

Returns:

the item's type information

valueOf

@NonNull
static ITokenItem valueOf(@NonNull
 String value)

Construct a new item using the provided string value.

Parameters:

value - a string representing a token value

Returns:

the new item

Throws:

InvalidTypeMetapathException - if the provided value is not a token

cast

@NonNull
static ITokenItem cast(@NonNull
 IAnyAtomicItem item)

Cast the provided type to this item type.

Parameters:

item - the item to cast

Returns:

the original item if it is already this type, otherwise a new item cast to this type

Throws:

InvalidValueForCastFunctionException - if the provided item cannot be cast to this type

castAsType

default ITokenItem castAsType(IAnyAtomicItem item)

Description copied from interface: IAnyAtomicItem

Cast the provided item to be the same type as this item.

Specified by:

castAsType in interface IAnyAtomicItem

Specified by:

castAsType in interface IStringItem

Parameters:

item - the item to cast

Returns:

an atomic item of this type