com.lightysoft.logmx.business

Class LogURL

java.lang.Object

com.lightysoft.logmx.business.LogURL

public class LogURL
extends Object

Locates a resource to open by a LogFileManager.

A LogURL contains LogURLParameter's storing URL information (e.g. host, port, path, login,...).

Example:
To create a LogURL for a HTTP Manager handling URLs like:

http://host[:port][/path]

you can use:

LogURL url = new LogURL();
url.addParameter(new LogURLParameter("Host", LogURLParameterType.HOST));
url.addParameter(new LogURLParameter("Port", LogURLParameterType.INTEGER, 80, true)); // optional, with default value 80
url.addParameter(new LogURLParameter("Path", LogURLParameterType.FILEPATH, null, true)); // optional, without default value


Since:

LogMX v1.2.2

Author:

LightySoft

See Also:

LogURLParameter

Constructor Summary

Constructors

Constructor and Description
LogURL() Create a LogURL containing no parameter

Method Summary

Modifier and Type	Method and Description
void	addParameter(LogURLParameter pParam) Adds a Parameter to this URL
Object	clone() Clone this URL (called by LogMX to clone URL returned by the Manager)
LogURLParameter	getParameter(String pParamName) Get the Parameter named pParamName.
List<LogURLParameter>	getParameters() Returns Parameters contained in this URL.
int	getSize() Returns the number of Parameters in this URL
LogURLParameter	removeParameter(String pParamName) Remove the Parameter named pParamName.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogURL

public LogURL()

Create a LogURL containing no parameter

Since:

LogMX v1.2.2

Method Detail

addParameter

public void addParameter(LogURLParameter pParam)

Adds a Parameter to this URL

Parameters:

pParam - Parameter to add

Since:

LogMX v1.2.2

getParameter

public LogURLParameter getParameter(String pParamName)

Get the Parameter named pParamName. This name must match the one you specified to create this Parameter.

Parameters:

pParamName - Name of the Parameter to retrieve

Returns:

Parameter named pParamName, or null if no such parameter

Since:

LogMX v1.2.2

removeParameter

public LogURLParameter removeParameter(String pParamName)

Remove the Parameter named pParamName. This name must match the one you specified to create this Parameter.

Parameters:

pParamName - Name of the Parameter to remove

Returns:

Parameter named pParamName, or null if no such parameter

Since:

LogMX v5.2.1

getSize

public int getSize()

Returns the number of Parameters in this URL

Returns:

Number of Parameters in this URL

Since:

LogMX v1.2.2

getParameters

public List<LogURLParameter> getParameters()

Returns Parameters contained in this URL. Returned list is a copy of internal map, so modifying this list will not modify this URL.

Returns:

Parameters contained in this URL

Since:

LogMX v1.2.2

clone

public Object clone()

Clone this URL (called by LogMX to clone URL returned by the Manager)

Overrides:

clone in class Object

Since:

LogMX v1.2.2

See Also:

Object.clone()