com.lightysoft.logmx.business

Class LogURLParameter

java.lang.Object

com.lightysoft.logmx.business.LogURLParameter

public class LogURLParameter
extends Object

Defines a parameter that will be sent to a LogFileManager in order to locate the resource to open.
A LogURLParameter defines a part of a LogURL.

For example, a LogURLParameter could be a login: its name will be "login" and its value (set by the LogMX user via the GUI) could be "john".

Since:

LogMX v1.2.2

Author:

LightySoft

See Also:

LogURL, LogURLParameterType

Constructor Summary

Constructors

Constructor and Description
LogURLParameter(String pName, LogURLParameterType pType) Construct a mandatory LogURLParameter with its name and type and no default value
LogURLParameter(String pName, LogURLParameterType pType, Object pDefaultValue) Construct a mandatory LogURLParameter with its name, type, and default value
LogURLParameter(String pName, LogURLParameterType pType, Object pDefaultValue, boolean pOptional) Construct an optional or mandatory LogURLParameter with its name, type, and default value
LogURLParameter(String pName, LogURLParameterType pType, Object pDefaultValue, boolean pOptional, Object[] pPossibleValues) Construct an optional or mandatory LogURLParameter with its name, type, default value, and possible values

Method Summary

Modifier and Type	Method and Description
Object	clone() Clone this Parameter (called by LogMX to clone LogURL returned by the Manager)
Object	getDefaultValue() Getter for attribute defaultValue: Default value that will be displayed in the GUI
String	getName() Getter for attribute name: Name that will be displayed in GUI just before the parameter's value
Object[]	getPossibleValues() Getter for attribute possibleValues: Possible values for parameters of type LogURLParameterType.ENUM only
String	getTooltip() Getter for attribute tooltip: Text that will appear in GUI as a tooltip for this parameter
LogURLParameterType	getType() Getter for attribute type: Parameter type used by LogMX to render the "Open file" dialog and to check parameters validity
Object	getValue() Getter for attribute value: Set by LogMX GUI to specify the parameter value to the Manager
boolean	isOptional() Getter for attribute optional: Indicates whether this parameter is optional
boolean	isUsedForConnection() Getter for attribute usedForConnection: Indicates whether this parameter is used to establish a connection
void	setDefaultValue(Object pDefaultValue) Setter for attribute defaultValue: Default value that will be displayed in the GUI
void	setOptional(boolean pOptional) Setter for attribute optional: Indicates whether this parameter is optional
void	setShouldBeDisplayAsGeneric(boolean pDisplayAsGeneric) Setter for attribute shouldBeDisplayedAsGeneric: Indicates whether this parameter should be displayed in "Open file" dialog with the other generic fields (used by some LogMX complex Managers for advanced parameters set in a separate panel of "Open file" dialog)
void	setTooltip(String pTooltip) Setter for attribute tooltip: Text that will appear in GUI as a tooltip for this parameter
void	setUsedForConnection(boolean pUsedForConnection) Setter for attribute usedForConnection: Indicates whether this parameter is used to establish a connection
void	setValue(Object pValue) Setter for attribute value: Set by LogMX GUI to specify the parameter value to the Manager
boolean	shouldBeDisplayedAsGeneric() Getter for attribute shouldBeDisplayedAsGeneric: Indicates whether this parameter should be displayed in "Open file" dialog with the other generic fields (used by some LogMX complex Managers for advanced parameters set in a separate panel of "Open file" dialog)

Methods inherited from class java.lang.Object

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

Constructor Detail

LogURLParameter

public LogURLParameter(String pName,
                       LogURLParameterType pType)

Construct a mandatory LogURLParameter with its name and type and no default value

Parameters:

pName - Parameter name (e.g. "login")

pType - Parameter type (e.g. LogURLParameterType.STRING)

Throws:

IllegalArgumentException - If pName or pType is null

Since:

LogMX v1.2.2

LogURLParameter

public LogURLParameter(String pName,
                       LogURLParameterType pType,
                       Object pDefaultValue)

Construct a mandatory LogURLParameter with its name, type, and default value

Parameters:

pName - Parameter name (e.g. "login")

pType - Parameter type (e.g. LogURLParameterType.STRING)

pDefaultValue - Parameter default value (e.g. "admin", System.getProperty("user.name"), or null if no default value)

Throws:

IllegalArgumentException - If pName or pType is null, or if pDefaultValue is not consistent with pType

Since:

LogMX v1.2.2

LogURLParameter

public LogURLParameter(String pName,
                       LogURLParameterType pType,
                       Object pDefaultValue,
                       boolean pOptional)

Construct an optional or mandatory LogURLParameter with its name, type, and default value

Parameters:

pName - Parameter name (e.g. "login")

pType - Parameter type (e.g. LogURLParameterType.STRING)

pDefaultValue - Parameter default value (e.g. "admin", System.getProperty("user.name"), or null if no default value)

pOptional - Indicates whether this parameter is optional

Throws:

IllegalArgumentException - If pName or pType is null, or if pDefaultValue is not consistent with pType

Since:

LogMX v1.2.2

LogURLParameter

public LogURLParameter(String pName,
                       LogURLParameterType pType,
                       Object pDefaultValue,
                       boolean pOptional,
                       Object[] pPossibleValues)

Construct an optional or mandatory LogURLParameter with its name, type, default value, and possible values

Parameters:

pName - Parameter name (e.g. "login")

pType - Parameter type (e.g. LogURLParameterType.STRING)

pDefaultValue - Parameter default value (e.g. "admin", System.getProperty("user.name"), or null if no default value)

pOptional - Indicates whether this parameter is optional

pPossibleValues - Possible values for this parameter (pType shall be LogURLParameterType.ENUM).
The method toString() will be called on array elements to be displayed in LogMX GUI.
Warning: Given array is cloned, but not its elements.

Throws:

IllegalArgumentException - If pName or pType is null, or if pDefaultValue is not consistent with pType

Since:

LogMX v4.0.0

Method Detail

clone

public Object clone()

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

Overrides:

clone in class Object

Since:

LogMX v1.2.2

See Also:

Object.clone()

getName

public String getName()

Getter for attribute name: Name that will be displayed in GUI just before the parameter's value

Returns:

Value of attribute name

Since:

LogMX v1.2.2

getValue

public Object getValue()

Getter for attribute value: Set by LogMX GUI to specify the parameter value to the Manager

Returns:

Value of attribute value

Since:

LogMX v1.2.2

setValue

public void setValue(Object pValue)

Setter for attribute value: Set by LogMX GUI to specify the parameter value to the Manager

Parameters:

pValue - New value for attribute value

Throws:

IllegalArgumentException - If pValue is not consistent with this parameter type

Since:

LogMX v1.2.2

getDefaultValue

public Object getDefaultValue()

Getter for attribute defaultValue: Default value that will be displayed in the GUI

Returns:

Value of attribute defaultValue

Since:

LogMX v1.2.2

setDefaultValue

public void setDefaultValue(Object pDefaultValue)

Setter for attribute defaultValue: Default value that will be displayed in the GUI

Parameters:

pDefaultValue - New value for attribute defaultValue

Throws:

IllegalArgumentException - If pDefaultValue is not consistent with this parameter type

Since:

LogMX v1.2.2

getType

public LogURLParameterType getType()

Getter for attribute type: Parameter type used by LogMX to render the "Open file" dialog and to check parameters validity

Returns:

Value of attribute type

Since:

LogMX v1.2.2

isOptional

public boolean isOptional()

Getter for attribute optional: Indicates whether this parameter is optional

Returns:

Value of attribute optional

Since:

LogMX v1.2.2

setOptional

public void setOptional(boolean pOptional)

Setter for attribute optional: Indicates whether this parameter is optional

Parameters:

pOptional - New value for attribute optional

Since:

LogMX v1.2.2

getTooltip

public String getTooltip()

Getter for attribute tooltip: Text that will appear in GUI as a tooltip for this parameter

Returns:

Value of attribute tooltip

Since:

LogMX v3.2.0

setTooltip

public void setTooltip(String pTooltip)

Setter for attribute tooltip: Text that will appear in GUI as a tooltip for this parameter

Parameters:

pTooltip - New value for attribute tooltip

Since:

LogMX v3.2.0

getPossibleValues

public Object[] getPossibleValues()

Getter for attribute possibleValues: Possible values for parameters of type LogURLParameterType.ENUM only

Returns:

Value of attribute possibleValues

Since:

LogMX v4.0.0

isUsedForConnection

public boolean isUsedForConnection()

Getter for attribute usedForConnection: Indicates whether this parameter is used to establish a connection

Returns:

Value of attribute usedForConnection

Since:

LogMX v6.0.0

setUsedForConnection

public void setUsedForConnection(boolean pUsedForConnection)

Setter for attribute usedForConnection: Indicates whether this parameter is used to establish a connection

Parameters:

pUsedForConnection - New value for attribute usedForConnection

Since:

LogMX v6.0.0

shouldBeDisplayedAsGeneric

public boolean shouldBeDisplayedAsGeneric()

Getter for attribute shouldBeDisplayedAsGeneric: Indicates whether this parameter should be displayed in "Open file" dialog with the other generic fields (used by some LogMX complex Managers for advanced parameters set in a separate panel of "Open file" dialog)

Returns:

Value of attribute shouldBeDisplayedAsGeneric

Since:

LogMX v8.0.0

setShouldBeDisplayAsGeneric

public void setShouldBeDisplayAsGeneric(boolean pDisplayAsGeneric)

Setter for attribute shouldBeDisplayedAsGeneric: Indicates whether this parameter should be displayed in "Open file" dialog with the other generic fields (used by some LogMX complex Managers for advanced parameters set in a separate panel of "Open file" dialog)

Parameters:

pDisplayAsGeneric - New value for attribute shouldBeDisplayedAsGeneric

Since:

LogMX v8.0.0