org.apache.ignite.internal.util.lang

Class GridMetadataAwareAdapter

java.lang.Object

org.apache.ignite.internal.util.lang.GridMetadataAwareAdapter

Direct Known Subclasses:

GridDeployment, IgniteTxAdapter, TcpDiscoveryNode

public class GridMetadataAwareAdapter
extends Object

Convenient adapter for working with metadata.

Thread Safety

This class provides necessary synchronization for thread-safe access.

Constructor Summary

Constructors

Constructor and Description
GridMetadataAwareAdapter() Default constructor.
GridMetadataAwareAdapter(Map<String,Object> data) Creates adapter with predefined data.

Method Summary

Methods

Modifier and Type	Method and Description
<V> V	addMeta(String name, V val) Adds a new metadata.
<V> V	addMetaIfAbsent(String name, Callable<V> c) Adds given metadata value only if it was absent.
<V> V	addMetaIfAbsent(String name, V val) Adds given metadata value only if it was absent.
<V> Map<String,V>	allMeta() Gets all metadata in this entry.
Object	clone()
void	copyMeta(GridMetadataAwareAdapter from) Copies all metadata from another instance.
void	copyMeta(Map<String,?> data) Copies all metadata from given map.
boolean	hasMeta(String name) Tests whether or not given metadata is set.
<V> boolean	hasMeta(String name, V val) Tests whether or not given metadata is set.
<V> V	meta(String name) Gets metadata by name.
<V> V	putMetaIfAbsent(String name, Callable<V> c) Adds given metadata value only if it was absent.
<V> V	putMetaIfAbsent(String name, V val) Adds given metadata value only if it was absent.
protected void	readExternalMeta(ObjectInput in) Convenience way for super-classes which implement Externalizable to serialize metadata.
<V> V	removeMeta(String name) Removes metadata by name.
<V> boolean	removeMeta(String name, V val) Removes metadata only if its current value is equal to val passed in.
<V> boolean	replaceMeta(String name, V curVal, V newVal) Replaces given metadata with new newVal value only if its current value is equal to curVal.
protected void	writeExternalMeta(ObjectOutput out) Convenience way for super-classes which implement Externalizable to serialize metadata.

Methods inherited from class java.lang.Object

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

Constructor Detail

GridMetadataAwareAdapter

public GridMetadataAwareAdapter()

Default constructor.

GridMetadataAwareAdapter

public GridMetadataAwareAdapter(Map<String,Object> data)

Creates adapter with predefined data.

Parameters:

data - Data to copy.

Method Detail

copyMeta

public void copyMeta(GridMetadataAwareAdapter from)

Copies all metadata from another instance.

Parameters:

from - Metadata aware instance to copy metadata from.

copyMeta

public void copyMeta(Map<String,?> data)

Copies all metadata from given map.

Parameters:

data - Map to copy metadata from.

addMeta

@Nullable
public <V> V addMeta(String name,
                     V val)

Adds a new metadata.

Type Parameters:

V - Type of the value.

Parameters:

name - Metadata name.

val - Metadata value.

Returns:

Metadata previously associated with given name, or null if there was none.

meta

@Nullable
public <V> V meta(String name)

Gets metadata by name.

Type Parameters:

V - Type of the value.

Parameters:

name - Metadata name.

Returns:

Metadata value or null.

removeMeta

@Nullable
public <V> V removeMeta(String name)

Removes metadata by name.

Type Parameters:

V - Type of the value.

Parameters:

name - Name of the metadata to remove.

Returns:

Value of removed metadata or null.

removeMeta

public <V> boolean removeMeta(String name,
                     V val)

Removes metadata only if its current value is equal to val passed in.

Type Parameters:

V - Value type.

Parameters:

name - Name of metadata attribute.

val - Value to compare.

Returns:

True if value was removed, false otherwise.

allMeta

public <V> Map<String,V> allMeta()

Gets all metadata in this entry.

Type Parameters:

V - Type of the value.

Returns:

All metadata in this entry.

hasMeta

public boolean hasMeta(String name)

Tests whether or not given metadata is set.

Parameters:

name - Name of the metadata to test.

Returns:

Whether or not given metadata is set.

hasMeta

public <V> boolean hasMeta(String name,
                  V val)

Tests whether or not given metadata is set.

Parameters:

name - Name of the metadata to test.

Returns:

Whether or not given metadata is set.

putMetaIfAbsent

@Nullable
public <V> V putMetaIfAbsent(String name,
                             V val)

Adds given metadata value only if it was absent.

Type Parameters:

V - Type of the value.

Parameters:

name - Metadata name.

val - Value to add if it's not attached already.

Returns:

null if new value was put, or current value if put didn't happen.

putMetaIfAbsent

@Nullable
public <V> V putMetaIfAbsent(String name,
                             Callable<V> c)

Adds given metadata value only if it was absent.

Type Parameters:

V - Type of the value.

Parameters:

name - Metadata name.

c - Factory closure to produce value to add if it's not attached already. Not that unlike addMeta(String, Object) method the factory closure will not be called unless the value is required and therefore value will only be created when it is actually needed.

Returns:

null if new value was put, or current value if put didn't happen.

addMetaIfAbsent

public <V> V addMetaIfAbsent(String name,
                    V val)

Adds given metadata value only if it was absent. Unlike putMetaIfAbsent(String, Callable), this method always returns the latest value and never previous one.

Type Parameters:

V - Type of the value.

Parameters:

name - Metadata name.

val - Value to add if it's not attached already.

Returns:

The value of the metadata after execution of this method.

addMetaIfAbsent

@Nullable
public <V> V addMetaIfAbsent(String name,
                             @Nullable
                             Callable<V> c)

Adds given metadata value only if it was absent.

Type Parameters:

V - Type of the value.

Parameters:

name - Metadata name.

c - Factory closure to produce value to add if it's not attached already. Not that unlike addMeta(String, Object) method the factory closure will not be called unless the value is required and therefore value will only be created when it is actually needed. If null and metadata value is missing - null will be returned from this method.

Returns:

The value of the metadata after execution of this method.

replaceMeta

public <V> boolean replaceMeta(String name,
                      V curVal,
                      V newVal)

Replaces given metadata with new newVal value only if its current value is equal to curVal. Otherwise, it is no-op.

Parameters:

name - Name of the metadata.

curVal - Current value to check.

newVal - New value.

Returns:

true if replacement occurred, false otherwise.

writeExternalMeta

protected void writeExternalMeta(ObjectOutput out)
                          throws IOException

Convenience way for super-classes which implement Externalizable to serialize metadata. Super-classes must call this method explicitly from within Externalizable.writeExternal(ObjectOutput) methods implementation.

Parameters:

out - Output to write to.

Throws:

IOException - If I/O error occurred.

readExternalMeta

protected void readExternalMeta(ObjectInput in)
                         throws IOException,
                                ClassNotFoundException

Convenience way for super-classes which implement Externalizable to serialize metadata. Super-classes must call this method explicitly from within Externalizable.readExternal(ObjectInput) methods implementation.

Parameters:

in - Input to read from.

Throws:

IOException - If I/O error occurred.

ClassNotFoundException - If some class could not be found.

clone

public Object clone()

Overrides:

clone in class Object