org.ishugaliy.allgood.consistent.hash

Interface ConsistentHash<T extends Node>

Type Parameters:

T - the type of node.

All Known Implementing Classes:

HashRing

public interface ConsistentHash<T extends Node>

Consistent Hash base interface

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
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
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
boolean	remove(T node) Remove node from the consistent hash
int	size() Return number of nodes inside consistent hash

Method Detail

getName

java.lang.String getName()

Return name of the consistent hash instance

Returns:

the name

add

boolean add(T node)

Add node to the consistent hash

Parameters:

node - the node to be added

Returns:

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

addAll

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

Add all nodes to the consistent hash

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

boolean contains(T node)

Check if consistent hash contains 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

boolean remove(T node)

Remove node from the consistent hash

Parameters:

node - the node to be removed

Returns:

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

getNodes

java.util.Set<T> getNodes()

Return list of all nodes that consistent hash contains

Returns:

the nodes list

locate

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

Find node which most matches the key

Parameters:

key - the key

Returns:

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

locate

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

Find nodes which most matches the key

Parameters:

key - the key

count - the amount of nodes to be matched

Returns:

the nodes list or empty list if no nodes were found

size

int size()

Return number of nodes inside consistent hash

Returns:

the size of consistent hash