org.ishugaliy.allgood.consistent.hash

Class HashRing<T extends Node>

java.lang.Object

org.ishugaliy.allgood.consistent.hash.HashRing<T>

Type Parameters:

T - the type of node to be used in the ring

All Implemented Interfaces:

ConsistentHash<T>

public final class HashRing<T extends Node>
extends java.lang.Object
implements ConsistentHash<T>

Implementation of Consistent Hash Ring with Virtual Nodes (partitions). Hash ring is based on Binary Search Tree - TreeMap

See Also:

Method Summary

Modifier and Type	Method and Description
boolean	add(T node) Add node to the consistent hash
boolean	addAll(java.util.Collection<T> nodes) Add all nodes to the consistent hash
boolean	contains(T node) Check if consistent hash contains node
Hasher	getHasher()
java.lang.String	getName() Return name of the consistent hash instance
java.util.Set<T>	getNodes() Return list of all nodes that consistent hash contains
int	getPartitionRate()
java.util.Optional<T>	locate(java.lang.String key) Find node which most matches the key
java.util.Set<T>	locate(java.lang.String key, int count) Find nodes which most matches the key
static <T extends Node> HashRingBuilder<T>	newBuilder() Create instance of HashRingBuilder
boolean	remove(T node) Remove node from the consistent hash
int	size() Return number of nodes inside consistent hash
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static <T extends Node> HashRingBuilder<T> newBuilder()

Create instance of HashRingBuilder

Type Parameters:

T - the type of node

Returns:

the hash ring builder

add

public boolean add(T node)

Description copied from interface: ConsistentHash

Add node to the consistent hash

Specified by:

add in interface ConsistentHash<T extends Node>

Parameters:

node - the node to be added

Returns:

true if node was added false if node was not added or node is null.

addAll

public boolean addAll(java.util.Collection<T> nodes)

Description copied from interface: ConsistentHash

Add all nodes to the consistent hash

Specified by:

addAll in interface ConsistentHash<T extends Node>

Parameters:

nodes - the nodes to be added

Returns:

true if at least one of the nodes were added false if no nodes were added or all of them are null.

contains

public boolean contains(T node)

Description copied from interface: ConsistentHash

Check if consistent hash contains node

Specified by:

contains in interface ConsistentHash<T extends Node>

Parameters:

node - the node to be checked

Returns:

true if hash contains node false if hash does not contain node or node is null

remove

public boolean remove(T node)

Description copied from interface: ConsistentHash

Remove node from the consistent hash

Specified by:

remove in interface ConsistentHash<T extends Node>

Parameters:

node - the node to be removed

Returns:

true if node was removed false if node was not removed or node is null

getNodes

public java.util.Set<T> getNodes()

Description copied from interface: ConsistentHash

Return list of all nodes that consistent hash contains

Specified by:

getNodes in interface ConsistentHash<T extends Node>

Returns:

the nodes list

locate

public java.util.Optional<T> locate(java.lang.String key)

Description copied from interface: ConsistentHash

Find node which most matches the key

Specified by:

locate in interface ConsistentHash<T extends Node>

Parameters:

key - the key

Returns:

the node or Optional.empty() if no node was found

locate

public java.util.Set<T> locate(java.lang.String key,
                               int count)

Description copied from interface: ConsistentHash

Find nodes which most matches the key

Specified by:

locate in interface ConsistentHash<T extends Node>

Parameters:

key - the key

count - the amount of nodes to be matched

Returns:

the nodes list or empty list if no nodes were found

getName

public java.lang.String getName()

Description copied from interface: ConsistentHash

Return name of the consistent hash instance

Specified by:

getName in interface ConsistentHash<T extends Node>

Returns:

the name

size

public int size()

Description copied from interface: ConsistentHash

Return number of nodes inside consistent hash

Specified by:

size in interface ConsistentHash<T extends Node>

Returns:

the size of consistent hash

getHasher

public Hasher getHasher()

getPartitionRate

public int getPartitionRate()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object