xsul.dispatcher.routingtable
Class RoutingTableImpl

java.lang.Object
  xsul.dispatcher.routingtable.RoutingTableImpl

All Implemented Interfaces:

RoutingTable

public class RoutingTableImpl

extends java.lang.Object

implements RoutingTable

An implementation of Routing Table. This implementation is based on a Concurrent Reader Hash Map and could be use a simple properties file to create its routing table.

Author:

Alexandre di Costanzo

See Also:

EDU.oswego.cs.dl.util.concurrent.ConcurrentReaderHashMap, RoutingTable

Constructor Summary

RoutingTableImpl()
Create a Routing table from the /xsul/dispatcher/routingtable/table.properties file.

RoutingTableImpl(java.io.File data)
Create a Routing table from a specified properties file.

RoutingTableImpl(int initialCapacity)
Create an empty Routing table.

RoutingTableImpl(int initialCapacity, float loadFactor)
Create an empty Routing table.

Method Summary

void	clear() Clears the Routing Table so that it contains no keys.
boolean	contains(java.lang.Object value) Tests if some key maps into the specified value in this Routing Table.
boolean	containsKey(java.lang.String key) Tests if the specified object is a key in this Routing Table.
boolean	containsKey(java.net.URI key) Tests if the specified object is a key in this Routing Table.
boolean	containsValue(java.lang.Object value) Returns true if this Routing Table maps one or more keys to this value.
java.util.Enumeration	elements() Returns an enumeration of the values in this Routing Table.
java.lang.Object	get(java.lang.String key) Returns the value to which the specified key is mapped in this Routing Table.
java.lang.Object	get(java.net.URI toKey) Returns the value to which the specified key is mapped in this Routing Table.
java.util.Map	getTable() Returns the whole routing table.
boolean	isEmpty() Tests if this Routing Table maps no keys to values.
java.util.Enumeration	keys() Returns an enumeration of the keys in this Routing Table.
java.lang.Object	put(java.lang.String key, java.lang.Object value) Maps the specified key to the specified value in this Routing Table.
java.lang.Object	put(java.net.URI key, java.lang.Object value) Maps the specified key to the specified value in this Routing Table.
void	putAll(RoutingTable t) Copies all of the mappings from the specified Map to this Routing Table These mappings will replace any mappings that this Routing Table had for any of the keys currently in the specified Routing Table.
java.lang.Object	remove(java.lang.String key) Removes the key (and its corresponding value) from this Routing Table.
java.lang.Object	remove(java.net.URI key) Removes the key (and its corresponding value) from this Routing Table.
int	size() Returns the number of keys in this Routing Table.
java.util.Collection	values() Returns a Collection view of the values contained in this Routing Table.

Methods inherited from class java.lang.Object

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

Constructor Detail

RoutingTableImpl

public RoutingTableImpl(int initialCapacity,
                        float loadFactor)

Create an empty Routing table.

Parameters:

initialCapacity - the initial capacity of the routing table.

loadFactor - the load factor of the routing table.

RoutingTableImpl

public RoutingTableImpl(int initialCapacity)

Create an empty Routing table.

Parameters:

initialCapacity - the initial capacity of the routing table.

RoutingTableImpl

public RoutingTableImpl()

Create a Routing table from the /xsul/dispatcher/routingtable/table.properties file.

RoutingTableImpl

public RoutingTableImpl(java.io.File data)

Create a Routing table from a specified properties file.

Parameters:

data - the specified file.

Method Detail

clear

public void clear()

Description copied from interface: RoutingTable

Clears the Routing Table so that it contains no keys.

Specified by:

clear in interface RoutingTable

See Also:

RoutingTable.clear()

contains

public boolean contains(java.lang.Object value)

Description copied from interface: RoutingTable

Tests if some key maps into the specified value in this Routing Table.

Specified by:

contains in interface RoutingTable

Parameters:

value - a value to search for.

Returns:

true if and only if some key maps to the value argument in this Routing Table as determined by the equals method; false otherwise.

See Also:

xsul.dispatcher.routingtable.RoutingTable#contains(xsul.dispatcher.routingtable.WS)

containsKey

public boolean containsKey(java.lang.String key)

Description copied from interface: RoutingTable

Tests if the specified object is a key in this Routing Table.

Specified by:

containsKey in interface RoutingTable

Parameters:

key - possible key.

Returns:

true if and only if the specified object is a key in this Routing Table, as determined by the equals method; false otherwise.

See Also:

RoutingTable.containsKey(java.lang.String)

containsValue

public boolean containsValue(java.lang.Object value)

Description copied from interface: RoutingTable

Returns true if this Routing Table maps one or more keys to this value.

Specified by:

containsValue in interface RoutingTable

Parameters:

value - value whose presence in this Routing Table is to be tested.

Returns:

true if this Routing Table maps one or more keys to the specified value.

See Also:

xsul.dispatcher.routingtable.RoutingTable#containsValue(xsul.dispatcher.routingtable.WS)

elements

public java.util.Enumeration elements()

Description copied from interface: RoutingTable

Returns an enumeration of the values in this Routing Table. Use the Enumeration methods on the returned object to fetch the elements sequentially.

Specified by:

elements in interface RoutingTable

Returns:

an enumeration of the values in this Routing Table.

See Also:

RoutingTable.elements()

get

public java.lang.Object get(java.lang.String key)

Description copied from interface: RoutingTable

Returns the value to which the specified key is mapped in this Routing Table.

Specified by:

get in interface RoutingTable

Parameters:

key - a key in the Routing Table.

Returns:

the value to which the key is mapped in this Routing Table; null if the key is not mapped to any value in this Routing Table.

See Also:

RoutingTable.get(java.lang.String)

isEmpty

public boolean isEmpty()

Description copied from interface: RoutingTable

Tests if this Routing Table maps no keys to values.

Specified by:

isEmpty in interface RoutingTable

Returns:

true if this Routing Table maps no keys to values; false otherwise.

See Also:

RoutingTable.isEmpty()

keys

public java.util.Enumeration keys()

Description copied from interface: RoutingTable

Returns an enumeration of the keys in this Routing Table.

Specified by:

keys in interface RoutingTable

Returns:

an enumeration of the keys in this Routing Table.

See Also:

RoutingTable.keys()

put

public java.lang.Object put(java.lang.String key,
                            java.lang.Object value)

Description copied from interface: RoutingTable

Maps the specified key to the specified value in this Routing Table. Neither the key nor the value can be null.

The value can be retrieved by calling the get method with a key that is equal to the original key.

Specified by:

put in interface RoutingTable

Parameters:

key - the Routing Table key.

value - the value.

Returns:

the previous value of the specified key in this Routing Table, or null if it did not have one.

See Also:

xsul.dispatcher.routingtable.RoutingTable#put(java.lang.String, xsul.dispatcher.routingtable.WS)

putAll

public void putAll(RoutingTable t)

Description copied from interface: RoutingTable

Copies all of the mappings from the specified Map to this Routing Table These mappings will replace any mappings that this Routing Table had for any of the keys currently in the specified Routing Table.

Specified by:

putAll in interface RoutingTable

Parameters:

t - Mappings to be stored in this Routing Table.

See Also:

xsul.dispatcher.routingtable.RoutingTable#putAll(xsul.dispatcher.routingtable.RoutingTableImpl)

remove

public java.lang.Object remove(java.lang.String key)

Description copied from interface: RoutingTable

Removes the key (and its corresponding value) from this Routing Table. This method does nothing if the key is not in the Routing Table.

Specified by:

remove in interface RoutingTable

Parameters:

key - the key that needs to be removed.

Returns:

the value to which the key had been mapped in this routing Table, or null if the key did not have a mapping.

See Also:

RoutingTable.remove(java.lang.String)

size

public int size()

Description copied from interface: RoutingTable

Returns the number of keys in this Routing Table.

Specified by:

size in interface RoutingTable

Returns:

the number of keys in this Routing Table.

See Also:

RoutingTable.size()

values

public java.util.Collection values()

Description copied from interface: RoutingTable

Returns a Collection view of the values contained in this Routing Table. The Collection is backed by the Routing Table, so changes to the Routing Table are reflected in the Collection, and vice-versa. The Collection supports element removal (which removes the corresponding entry from the Routing Table), but not element addition.

Specified by:

values in interface RoutingTable

Returns:

a collection view of the values contained in this Routing Table.

See Also:

RoutingTable.values()

getTable

public java.util.Map getTable()

Description copied from interface: RoutingTable

Returns the whole routing table.

Specified by:

getTable in interface RoutingTable

Returns:

a map view of the whole Routing Table.

containsKey

public boolean containsKey(java.net.URI key)

Description copied from interface: RoutingTable

Tests if the specified object is a key in this Routing Table.

Specified by:

containsKey in interface RoutingTable

Parameters:

key - possible key.

Returns:

true if and only if the specified object is a key in this Routing Table, as determined by the equals method; false otherwise.

See Also:

RoutingTable.containsKey(java.net.URI)

get

public java.lang.Object get(java.net.URI toKey)

Description copied from interface: RoutingTable

Returns the value to which the specified key is mapped in this Routing Table.

Specified by:

get in interface RoutingTable

Returns:

the value to which the key is mapped in this Routing Table; null if the key is not mapped to any value in this Routing Table.

See Also:

RoutingTable.get(java.net.URI)

put

public java.lang.Object put(java.net.URI key,
                            java.lang.Object value)

Description copied from interface: RoutingTable

Maps the specified key to the specified value in this Routing Table. Neither the key nor the value can be null.

The value can be retrieved by calling the get method with a key that is equal to the original key.

Specified by:

put in interface RoutingTable

Parameters:

key - the Routing Table key.

value - the value.

Returns:

the previous value of the specified key in this Routing Table, or null if it did not have one.

See Also:

xsul.dispatcher.routingtable.RoutingTable#put(java.net.URI, xsul.dispatcher.routingtable.WS)

remove

public java.lang.Object remove(java.net.URI key)

Description copied from interface: RoutingTable

Removes the key (and its corresponding value) from this Routing Table. This method does nothing if the key is not in the Routing Table.

Specified by:

remove in interface RoutingTable

Parameters:

key - the key that needs to be removed.

Returns:

the value to which the key had been mapped in this routing Table, or null if the key did not have a mapping.

See Also:

RoutingTable.remove(java.net.URI)