Module dev.metaschema.core

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

Interface IPositiveIntegerItem

All Superinterfaces:

IAnyAtomicItem, IAtomicValuedItem, ICollectionValue, IDecimalItem, IIntegerItem, IItem, INonNegativeIntegerItem, INumericItem

public interface IPositiveIntegerItem
extends INonNegativeIntegerItem

An atomic Metapath item containing a positive integer data value.

Field Summary

Fields

Modifier and Type	Field	Description
static final IPositiveIntegerItem	ONE	The integer value "1".

Fields inherited from interface dev.metaschema.core.metapath.item.atomic.IIntegerItem

NEGATIVE_ONE

Fields inherited from interface dev.metaschema.core.metapath.item.atomic.INonNegativeIntegerItem

ZERO

Method Summary

Modifier and Type	Method	Description
static IPositiveIntegerItem	cast(IAnyAtomicItem item)	Cast the provided type to this item type.
default IPositiveIntegerItem	castAsType(IAnyAtomicItem item)	Cast the provided item to be the same type as this item.
default IAtomicOrUnionType<IPositiveIntegerItem>	getType()	Get the type information for the item.
static IAtomicOrUnionType<IPositiveIntegerItem>	type()	Get the type information for this item.
static IPositiveIntegerItem	valueOf(long value)	Create an item from an existing integer value.
static IPositiveIntegerItem	valueOf(INumericItem value)	Create an item from an existing integer value.
static IPositiveIntegerItem	valueOf(String value)	Create an item from an existing integer value.
static IPositiveIntegerItem	valueOf(BigInteger value)	Create an item from an existing integer value.

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

accept, asMapKey, asString, asStringItem, 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.atomic.IDecimalItem

add, compareTo, divide, integerDivide, mod, multiply, subtract, toEffectiveBoolean

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

abs, add, ceiling, compareTo, floor, integerDivide, mod, multiply, negate, subtract, toIntValueExact

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

contentsAsSequence, flatten, hasValue, toSequence

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

add, asDecimal, asInteger, divide, multiply, round, round, subtract

Field Details

ONE

@NonNull
static final IPositiveIntegerItem ONE

The integer value "1".

Method Details

type

@NonNull
static IAtomicOrUnionType<IPositiveIntegerItem> type()

Get the type information for this item.

Returns:

the type information

getType

default IAtomicOrUnionType<IPositiveIntegerItem> getType()

Description copied from interface: IItem

Get the type information for the item.

Specified by:

getType in interface IDecimalItem

Specified by:

getType in interface IIntegerItem

Specified by:

getType in interface IItem

Specified by:

getType in interface INonNegativeIntegerItem

Returns:

the item's type information

valueOf

@NonNull
static IPositiveIntegerItem valueOf(@NonNull
 String value)

Create an item from an existing integer value.

Parameters:

value - a string representing an integer value

Returns:

the item

Throws:

InvalidTypeMetapathException - if the provided value is not a positive integer

valueOf

@NonNull
static IPositiveIntegerItem valueOf(@NonNull
 INumericItem value)

Create an item from an existing integer value.

Parameters:

value - an integer value

Returns:

the item

Throws:

InvalidTypeMetapathException - if the provided value is not a positive integer

valueOf

@NonNull
static IPositiveIntegerItem valueOf(long value)

Create an item from an existing integer value.

Parameters:

value - an integer value

Returns:

the item

Throws:

InvalidTypeMetapathException - if the provided value is not a positive integer

valueOf

@NonNull
static IPositiveIntegerItem valueOf(@NonNull
 BigInteger value)

Create an item from an existing integer value.

Parameters:

value - an integer value

Returns:

the item

Throws:

InvalidTypeMetapathException - if the provided value is not a positive integer

cast

@NonNull
static IPositiveIntegerItem 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 IPositiveIntegerItem 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 IDecimalItem

Specified by:

castAsType in interface IIntegerItem

Specified by:

castAsType in interface INonNegativeIntegerItem

Specified by:

castAsType in interface INumericItem

Parameters:

item - the item to cast

Returns:

an atomic item of this type