Module org.bzdev.ejws

Package org.bzdev.ejws.maps

Class PropertiesWebMap

java.lang.Object

org.bzdev.ejws.WebMap

org.bzdev.ejws.maps.PropertiesWebMap

All Implemented Interfaces:

WebMap.ColorSpec

public class PropertiesWebMap
extends WebMap
implements WebMap.ColorSpec

WebMap for resources in a Properties object. The sole argument to a PpropertyWebMap's constructor is a Properties instance whose keys are path names or a PropertiesWebMap.Config providing a Properties instance as its first argument. The value associated with a property's name is the object that should be be provided by the map.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PropertiesWebMap.Config	DirWebMap configurator.

Nested classes/interfaces inherited from class org.bzdev.ejws.WebMap

WebMap.ColorSpec, WebMap.Info, WebMap.RequestInfo

Constructor Summary

Constructors

Constructor	Description
PropertiesWebMap(Object properties)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getBackgroundColor()	Get the background color to use for HTML pages.
String	getColor()	Get the foreground color to use for HTML pages.
protected WebMap.Info	getInfoFromPath(String prepath, String epath, String query, String fragment, WebMap.RequestInfo requestInfo)	Get an Info object for a resource.
String	getLinkColor()	Get the color to use for unvisited links.
String	getVisitedColor()	Get the color to use for visited links.
void	setProperties(Properties properties)	Set this opject's properties.
void	update()	Reinitialize the state of this object.

Methods inherited from class org.bzdev.ejws.WebMap

acceptsMethod, addErrorEntry, addGzipSuffix, addMapping, addPageEncoding, addPageEncoding, addWelcome, allowsQuery, asHeaderOps, configure, deconfigure, getContentTypeFromURL, getDisplayDir, getEmap, getEncodingFromURL, getErrorBackgroundColor, getErrorForegroundColor, getErrorInfo, getErrorInfo, getErrorInfo, getFromHeader, getInfo, getInfo, getInfo, getInfo, getInfo, getInfoFromPath, getMimeType, getSuffixToMimeTypeMap, getWebInfHidden, getWebxml, getWelcomeInfo, getWelcomeInfo, getWelcomeList, gzipPaths, newInstance, newInstance, setAdminAlias, setAllowsQuery, setDisplayDir, setErrorColors, setLoginAlias, setLoginAlias, setLoginAlias, setLoginAlias, setLoginAlias, setLogoutAlias, setMethods, setWebInfHidden, stripGZipSuffix, welcomeInfoAvailable

Methods inherited from class java.lang.Object

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

Constructor Details

PropertiesWebMap

public PropertiesWebMap(Object properties)
                 throws IllegalArgumentException

Constructor.

Parameters:

properties - a Properties instance or an instance of PropertiesWebMap.Config

Throws:

IllegalArgumentException

Method Details

getColor

public String getColor()

Description copied from interface: WebMap.ColorSpec

Get the foreground color to use for HTML pages.

Specified by:

getColor in interface WebMap.ColorSpec

Returns:

the CSS color for the foreground

getBackgroundColor

public String getBackgroundColor()

Description copied from interface: WebMap.ColorSpec

Get the background color to use for HTML pages.

Specified by:

getBackgroundColor in interface WebMap.ColorSpec

Returns:

the CSS color for the background

getLinkColor

public String getLinkColor()

Description copied from interface: WebMap.ColorSpec

Get the color to use for unvisited links.

Specified by:

getLinkColor in interface WebMap.ColorSpec

Returns:

the CSS color for links

getVisitedColor

public String getVisitedColor()

Description copied from interface: WebMap.ColorSpec

Get the color to use for visited links.

Specified by:

getVisitedColor in interface WebMap.ColorSpec

Returns:

the CSS color for visited links

setProperties

public void setProperties(Properties properties)

Set this opject's properties.

Parameters:

properties - the properties

update

public void update()

Reinitialize the state of this object. This method should be called if the Properties instance passed to this object's constructor is modified. are modified.

getInfoFromPath

protected WebMap.Info getInfoFromPath(String prepath,
 String epath,
 String query,
 String fragment,
 WebMap.RequestInfo requestInfo)

Get an Info object for a resource. Only the path component is used.

Specified by:

getInfoFromPath in class WebMap

Parameters:

prepath - the initial portion of the request URI - the part before the path portion of the URI

epath - the relative path to the resource

query - the query portion of the request URI

fragment - the fragment portion of the request URI

requestInfo - an object encapsulating request data (headers, input streams, etc.)

Returns:

an Info object describing properties of a resource and providing an input stream to the resource