com.ihr.xbrl.util

Class EqualsCache<T extends HasEqualsCache>

java.lang.Object

com.ihr.xbrl.util.EqualsCache<T>

Type Parameters:

T - the generic type

public class EqualsCache<T extends HasEqualsCache>
extends java.lang.Object

This class implements a fact cache over the result of equals when the equals method is expensive.

It is required that classes implementing this interface in the equals method are marked with the HasEqualsCache in the class definition

This class is thread safe

Author:

Ignacio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EqualsCache.Equals<Z> Required interface for the lambda method to compare two objects.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all cached values.
boolean	equals(T o1, T o2, EqualsCache.Equals<T> method) Use this method to compare equals of two objects of T type.
static <Z extends HasEqualsCache> EqualsCache<Z>	newInstance() Factory method to create a new instance of the EqualsCache class.
static <Z extends HasEqualsCache> EqualsCache<Z>	newInstance(int capacity) Factory method to create a new instance of the EqualsCache class.
void	remove(HasEqualsCache o) Use this method to remove a object from the cache.

Methods inherited from class java.lang.Object

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

Method Detail

equals

public boolean equals(T o1,
                      T o2,
                      EqualsCache.Equals<T> method)

Use this method to compare equals of two objects of T type. If the value is already in the cache, the existing cached value is returned. Otherwise, the lambda method is called and the value is stored in the cache

Parameters:

o1 - first object to compare

o2 - second object to compare

method - the lambda method to compare two instances of T

Returns:

same value as equals(o1, o2)

remove

public void remove(HasEqualsCache o)

Use this method to remove a object from the cache. This is necessary when the object compared has changed.

Parameters:

o - object to remove

newInstance

public static <Z extends HasEqualsCache> EqualsCache<Z> newInstance()

Factory method to create a new instance of the EqualsCache class.

Type Parameters:

Z - the generic type

Returns:

new cache instance

newInstance

public static <Z extends HasEqualsCache> EqualsCache<Z> newInstance(int capacity)

Factory method to create a new instance of the EqualsCache class.

Type Parameters:

Z - the generic type

Parameters:

capacity - maximum pairs of values stored in the cache

Returns:

new cache instance

clear

public void clear()

Removes all cached values.