com.comphenix.protocol.wrappers

Class TroveWrapper

java.lang.Object

com.comphenix.protocol.wrappers.TroveWrapper

public class TroveWrapper
extends java.lang.Object

Wrap a GNU Trove Collection class with an equivalent Java Collection class.

Author:

Kristian

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TroveWrapper.CannotFindTroveNoEntryValue

Constructor Summary

Constructors

Constructor and Description
TroveWrapper()

Method Summary

Methods

Modifier and Type	Method and Description
static <TValue> java.util.List<TValue>	getDecoratedList(java.lang.Object troveList) Retrieve a Java wrapper for the corresponding Trove list.
static <TKey,TValue> java.util.Map<TKey,TValue>	getDecoratedMap(java.lang.Object troveMap) Retrieve a Java wrapper for the corresponding Trove map.
static <TValue> java.util.Set<TValue>	getDecoratedSet(java.lang.Object troveSet) Retrieve a Java wrapper for the corresponding Trove set.
static boolean	isTroveClass(java.lang.Class<?> clazz) Determine if the given class is found within gnu.trove.
static void	transformNoEntryValue(java.lang.Object troveMap, com.google.common.base.Function<java.lang.Integer,java.lang.Integer> transform) Transform the no entry value in the given map.
static ReadOnlyFieldAccessor	wrapListField(FieldAccessor accessor) Retrieve a read-only field accessor that automatically wraps the underlying Trove instance.
static ReadOnlyFieldAccessor	wrapMapField(FieldAccessor accessor) Retrieve a read-only field accessor that automatically wraps the underlying Trove instance.
static ReadOnlyFieldAccessor	wrapMapField(FieldAccessor accessor, com.google.common.base.Function<java.lang.Integer,java.lang.Integer> noEntryTransform) Retrieve a read-only field accessor that automatically wraps the underlying Trove instance.
static ReadOnlyFieldAccessor	wrapSetField(FieldAccessor accessor) Retrieve a read-only field accessor that automatically wraps the underlying Trove instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

TroveWrapper

public TroveWrapper()

Method Detail

wrapMapField

public static ReadOnlyFieldAccessor wrapMapField(FieldAccessor accessor)

Retrieve a read-only field accessor that automatically wraps the underlying Trove instance.

Parameters:

accessor - - the accessor.

Returns:

The read only accessor.

wrapMapField

public static ReadOnlyFieldAccessor wrapMapField(FieldAccessor accessor,
                                 com.google.common.base.Function<java.lang.Integer,java.lang.Integer> noEntryTransform)

Retrieve a read-only field accessor that automatically wraps the underlying Trove instance.

Parameters:

accessor - - the accessor.

noEntryTransform - - transform the no entry value, or NULL to ignore.

Returns:

The read only accessor.

wrapSetField

public static ReadOnlyFieldAccessor wrapSetField(FieldAccessor accessor)

Retrieve a read-only field accessor that automatically wraps the underlying Trove instance.

Parameters:

accessor - - the accessor.

Returns:

The read only accessor.

wrapListField

public static ReadOnlyFieldAccessor wrapListField(FieldAccessor accessor)

Retrieve a read-only field accessor that automatically wraps the underlying Trove instance.

Parameters:

accessor - - the accessor.

Returns:

The read only accessor.

getDecoratedMap

public static <TKey,TValue> java.util.Map<TKey,TValue> getDecoratedMap(@Nonnull
                                                       java.lang.Object troveMap)

Retrieve a Java wrapper for the corresponding Trove map.

Parameters:

troveMap - - the trove map to wrap.

Returns:

The wrapped GNU Trove map.

Throws:

java.lang.IllegalStateException - If GNU Trove cannot be found in the class map.

java.lang.IllegalArgumentException - If troveMap is NULL.

FieldAccessException - Error in wrapper method or lack of reflection permissions.

getDecoratedSet

public static <TValue> java.util.Set<TValue> getDecoratedSet(@Nonnull
                                             java.lang.Object troveSet)

Retrieve a Java wrapper for the corresponding Trove set.

Parameters:

troveSet - - the trove set to wrap.

Returns:

The wrapped GNU Trove set.

Throws:

java.lang.IllegalStateException - If GNU Trove cannot be found in the class map.

java.lang.IllegalArgumentException - If troveSet is NULL.

FieldAccessException - Error in wrapper method or lack of reflection permissions.

getDecoratedList

public static <TValue> java.util.List<TValue> getDecoratedList(@Nonnull
                                               java.lang.Object troveList)

Retrieve a Java wrapper for the corresponding Trove list.

Parameters:

troveList - - the trove list to wrap.

Returns:

The wrapped GNU Trove list.

Throws:

java.lang.IllegalStateException - If GNU Trove cannot be found in the class map.

java.lang.IllegalArgumentException - If troveList is NULL.

FieldAccessException - Error in wrapper method or lack of reflection permissions.

isTroveClass

public static boolean isTroveClass(java.lang.Class<?> clazz)

Determine if the given class is found within gnu.trove.

Parameters:

clazz - - the clazz.

Returns:

TRUE if it is, FALSE otherwise.

transformNoEntryValue

public static void transformNoEntryValue(java.lang.Object troveMap,
                         com.google.common.base.Function<java.lang.Integer,java.lang.Integer> transform)

Transform the no entry value in the given map.

Parameters:

troveMap - - the trove map.

transform - - the transform.