org.gridgain.grid.spi.indexing

Interface GridIndexingEntity<T>

All Known Implementing Classes:

GridIndexingEntityAdapter

public interface GridIndexingEntity<T>

Wrapper around indexed key or value which also may contain the value in unmarshalled form. It exists to avoid unnecessary unmarshalling whenever it is not needed. See also GridIndexingSpi.queryFields(String, String, Collection, GridIndexingQueryFilter[]).

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	bytes() Optional bytes for marshaled indexed value.
boolean	hasValue() Flag indicating whether this entity contains unmarshalled value.
T	value() Gets indexed value.

Method Detail

value

@Nullable
T value()
        throws GridSpiException

Gets indexed value. This method may return null only if actual value is null. Otherwise, it will unmarshal the bytes() and return the actual value.

Returns:

Indexed value.

Throws:

GridSpiException - If value de-serialization failed.

bytes

@Nullable
byte[] bytes()

Optional bytes for marshaled indexed value. Certain SPI implementations may keep objects in unmarshalled form and therefore will not provide marshaled bytes for them.

Returns:

Optional marshaled value.

hasValue

boolean hasValue()

Flag indicating whether this entity contains unmarshalled value.

Returns:

True if entity contains unmarshalled value, false otherwise.