org.apache.commons.discovery.resource.names

Class DiscoverNamesInDictionary

java.lang.Object

org.apache.commons.discovery.resource.names.ResourceNameDiscoverImpl

org.apache.commons.discovery.resource.names.DiscoverNamesInDictionary

All Implemented Interfaces:

ResourceNameDiscover

public class DiscoverNamesInDictionary
extends ResourceNameDiscoverImpl
implements ResourceNameDiscover

Recover resources from a Dictionary. This covers Properties as well, since Properties extends Hashtable extends Dictionary. The recovered value is expected to be either a String or a String[].

Constructor Summary

Constructors

Constructor and Description
DiscoverNamesInDictionary() Construct a new resource discoverer with an empty Dictionary.
DiscoverNamesInDictionary(java.util.Dictionary<java.lang.String,java.lang.String[]> dictionary) Construct a new resource discoverer with the given Dictionary.

Method Summary

Methods

Modifier and Type	Method and Description
void	addResource(java.lang.String resourceName, java.lang.String resource) Add a resource name to a single name mapping.
void	addResource(java.lang.String resourceName, java.lang.String[] resources) Add a resource name to multiple names mapping.
ResourceNameIterator	findResourceNames(java.lang.String resourceName) Locate names of resources that are bound to resourceName.
protected java.util.Dictionary<java.lang.String,java.lang.String[]>	getDictionary() Returns the current Dictionary for names mapping.
void	setDictionary(java.util.Dictionary<java.lang.String,java.lang.String[]> table) Specify the Dictionary for names mapping.
static void	setLog(org.apache.commons.logging.Log _log) Deprecated. This method is not thread-safe

Methods inherited from class org.apache.commons.discovery.resource.names.ResourceNameDiscoverImpl

findResourceNames

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.commons.discovery.ResourceNameDiscover

findResourceNames

Constructor Detail

DiscoverNamesInDictionary

public DiscoverNamesInDictionary()

Construct a new resource discoverer with an empty Dictionary.

DiscoverNamesInDictionary

public DiscoverNamesInDictionary(java.util.Dictionary<java.lang.String,java.lang.String[]> dictionary)

Construct a new resource discoverer with the given Dictionary.

Parameters:

dictionary - The initial Dictionary

Method Detail

setLog

@Deprecated
public static void setLog(org.apache.commons.logging.Log _log)

Deprecated. This method is not thread-safe

Sets the Log for this class.

Parameters:

_log - This class Log

getDictionary

protected java.util.Dictionary<java.lang.String,java.lang.String[]> getDictionary()

Returns the current Dictionary for names mapping.

Returns:

The current Dictionary for names mapping

setDictionary

public void setDictionary(java.util.Dictionary<java.lang.String,java.lang.String[]> table)

Specify the Dictionary for names mapping.

Parameters:

table - The Dictionary for names mapping

addResource

public void addResource(java.lang.String resourceName,
               java.lang.String resource)

Add a resource name to a single name mapping.

Parameters:

resourceName - The resource name

resource - The target name

addResource

public void addResource(java.lang.String resourceName,
               java.lang.String[] resources)

Add a resource name to multiple names mapping.

Parameters:

resourceName - The resource name

resources - The target names

findResourceNames

public ResourceNameIterator findResourceNames(java.lang.String resourceName)

Locate names of resources that are bound to resourceName.

Specified by:

findResourceNames in interface ResourceNameDiscover

Specified by:

findResourceNames in class ResourceNameDiscoverImpl

Parameters:

resourceName - The resource name to locate

Returns:

A new ResourceNameIterator