org.infinispan.metadata

Interface Metadata

All Known Subinterfaces:

InternalMetadata

All Known Implementing Classes:

EmbeddedMetadata, InternalMetadataImpl, JCacheInternalMetadata, MemcachedMetadata, MimeMetadata

public interface Metadata

This interface encapsulates metadata information that can be stored alongside values in the cache.

Since:

5.3

Author:

Galder Zamarreño

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Metadata.Builder Metadata builder

Method Summary

Methods

Modifier and Type	Method and Description
Metadata.Builder	builder() Returns an instance of Metadata.Builder which can be used to build new instances of Metadata instance which are full copies of this Metadata.
long	lifespan() Returns the lifespan of the cache entry with which this metadata object is associated, in milliseconds.
long	maxIdle() Returns the the maximum amount of time that the cache entry associated with this metadata object is allowed to be idle for before it is considered as expired, in milliseconds.
EntryVersion	version() Returns the version of the cache entry with which this metadata object is associated.

Method Detail

lifespan

long lifespan()

Returns the lifespan of the cache entry with which this metadata object is associated, in milliseconds. Negative values are interpreted as unlimited lifespan.

Returns:

lifespan of the entry in number of milliseconds

maxIdle

long maxIdle()

Returns the the maximum amount of time that the cache entry associated with this metadata object is allowed to be idle for before it is considered as expired, in milliseconds.

Returns:

maximum idle time of the entry in number of milliseconds

version

EntryVersion version()

Returns the version of the cache entry with which this metadata object is associated.

Returns:

version of the entry

builder

Metadata.Builder builder()

Returns an instance of Metadata.Builder which can be used to build new instances of Metadata instance which are full copies of this Metadata.

Returns:

instance of Metadata.Builder