Package com.barden.library.metadata

Class Metadata

java.lang.Object

com.barden.library.metadata.Metadata

public final class Metadata
extends Object

Metadata object.

Constructor Summary

Constructors

Constructor	Description
Metadata()

Method Summary

Modifier and Type	Method	Description
Metadata	add(Object key)	Adds metadata key.
Metadata	add(Object key, TimeUnit unit, int duration)	Adds metadata.
Metadata	add(Object key, TimeUnit unit, int duration, Consumer<Metadata> expireHandler)	Adds metadata.
<T> T	get(Object key)	Gets metadata.
<T> T	get(Object key, Class<T> valueClass)	Gets metadata.
<T> T	get(Object key, T defaultValue)	Gets metadata.
<T> T	getNonNull(Object key)	Gets metadata nonnull.
<T> T	getNonNull(Object key, Class<T> valueClass)	Gets metadata nonnull.
boolean	has(Object key)	Gets if metadata registered or not.
Metadata	remove(Object key)	Removes metadata.
void	reset()	Resets metadata.
Metadata	set(Object key, Object value)	Sets metadata.
Metadata	set(Object key, Object value, TimeUnit unit, int duration)	Sets metadata.
Metadata	set(Object key, Object value, TimeUnit unit, int duration, Consumer<Metadata> expireHandler)	Sets metadata.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Metadata

public Metadata()

Method Details

has

public boolean has(@Nonnull
 Object key)

Gets if metadata registered or not.

Parameters:

key - Key.

Returns:

If metadata registered or not.

get

@Nullable
public <T> T get(@Nonnull
 Object key)

Gets metadata.

Type Parameters:

T - Value type.

Parameters:

key - Key.

Returns:

Value.

get

@Nullable
public <T> T get(@Nonnull
 Object key,
 @Nonnull
 Class<T> valueClass)

Gets metadata.

Type Parameters:

T - Value type.

Parameters:

key - Key.

valueClass - Value class.

Returns:

Value.

getNonNull

@Nonnull
public <T> T getNonNull(@Nonnull
 Object key)

Gets metadata nonnull.

Type Parameters:

T - Value type.

Parameters:

key - Key.

Returns:

Value.

getNonNull

@Nonnull
public <T> T getNonNull(@Nonnull
 Object key,
 @Nonnull
 Class<T> valueClass)

Gets metadata nonnull.

Type Parameters:

T - Value type.

Parameters:

key - Key.

valueClass - Value class.

Returns:

Value.

get

@Nonnull
public <T> T get(@Nonnull
 Object key,
 T defaultValue)

Gets metadata.

Type Parameters:

T - Value type.

Parameters:

key - Key.

defaultValue - Default value.

Returns:

Value.

set

@Nonnull
public Metadata set(@Nonnull
 Object key,
 @Nonnull
 Object value)

Sets metadata.

Parameters:

key - Key.

value - Value.

Returns:

Metadata.

set

@Nonnull
public Metadata set(@Nonnull
 Object key,
 @Nonnull
 Object value,
 @Nonnull
 TimeUnit unit,
 int duration)

Sets metadata.

Parameters:

key - Key.

value - Value.

unit - Time unit.

duration - Duration.

Returns:

Metadata.

set

@Nonnull
public Metadata set(@Nonnull
 Object key,
 @Nonnull
 Object value,
 @Nonnull
 TimeUnit unit,
 int duration,
 @Nullable
 Consumer<Metadata> expireHandler)

Sets metadata.

Parameters:

key - Key.

value - Value.

unit - Time unit.

duration - Duration.

expireHandler - Expire handler. (Optional)

Returns:

Metadata.

add

@Nonnull
public Metadata add(@Nonnull
 Object key)

Adds metadata key.

Parameters:

key - Key.

Returns:

Metadata.

add

@Nonnull
public Metadata add(@Nonnull
 Object key,
 @Nonnull
 TimeUnit unit,
 int duration)

Adds metadata.

Parameters:

key - Key.

unit - Time unit.

duration - Duration.

Returns:

Metadata.

add

@Nonnull
public Metadata add(@Nonnull
 Object key,
 @Nonnull
 TimeUnit unit,
 int duration,
 @Nullable
 Consumer<Metadata> expireHandler)

Adds metadata.

Parameters:

key - Key.

unit - Time unit.

duration - Duration.

expireHandler - Expire handler. (Optional)

Returns:

Metadata.

remove

@Nonnull
public Metadata remove(@Nonnull
 Object key)

Removes metadata.

Parameters:

key - Key.

Returns:

Metadata.

reset

public void reset()

Resets metadata.