public class LogURLParameter extends Object
LogFileManager
in order to locate the resource to open.LogURLParameter
defines a part of a LogURL
.LogURL
,
LogURLParameterType
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 |
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 |
String |
getName()
Getter for attribute
name |
Object[] |
getPossibleValues()
Getter for attribute
possibleValues |
String |
getTooltip()
Getter for attribute
tooltip |
LogURLParameterType |
getType()
Getter for attribute
type |
Object |
getValue()
Getter for attribute
value |
boolean |
isOptional()
Getter for attribute
optional |
boolean |
isUsedForConnection()
Getter for attribute
usedForConnection |
void |
setDefaultValue(Object pDefaultValue)
Setter for attribute
defaultValue |
void |
setOptional(boolean pOptional)
Setter for attribute
optional |
void |
setTooltip(String pTooltip)
Setter for attribute
tooltip |
void |
setUsedForConnection(boolean pUsedForConnection)
Setter for attribute
usedForConnection |
void |
setValue(Object pValue)
Setter for attribute
value |
public LogURLParameter(String pName, LogURLParameterType pType)
LogURLParameter
with its name and type and no default valuepName
- Parameter name (e.g. "login")pType
- Parameter type (e.g. LogURLParameterType.STRING
)IllegalArgumentException
- If pName
or pType
is null
public LogURLParameter(String pName, LogURLParameterType pType, Object pDefaultValue)
LogURLParameter
with its name, type, and default valuepName
- 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)IllegalArgumentException
- If pName
or pType
is null
, or if pDefaultValue
is not consistent with pType
public LogURLParameter(String pName, LogURLParameterType pType, Object pDefaultValue, boolean pOptional)
LogURLParameter
with its name, type, and default valuepName
- 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 optionalIllegalArgumentException
- If pName
or pType
is null
, or if pDefaultValue
is not consistent with pType
public LogURLParameter(String pName, LogURLParameterType pType, Object pDefaultValue, boolean pOptional, Object[] pPossibleValues)
LogURLParameter
with its name, type, default value, and possible valuespName
- 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 optionalpPossibleValues
- Possible values for this parameter (pType
shall be LogURLParameterType.ENUM
).toString()
will be called on array elements to be displayed in LogMX GUI.IllegalArgumentException
- If pName
or pType
is null
, or if pDefaultValue
is not consistent with pType
public Object clone()
LogURL
returned by the Manager)clone
in class Object
Object.clone()
public String getName()
name
name
public Object getValue()
value
value
public void setValue(Object pValue)
value
pValue
- New value for attribute value
IllegalArgumentException
- If pValue
is not consistent with this parameter typepublic Object getDefaultValue()
defaultValue
defaultValue
public void setDefaultValue(Object pDefaultValue)
defaultValue
pDefaultValue
- New value for attribute defaultValue
IllegalArgumentException
- If pDefaultValue
is not consistent with this parameter typepublic LogURLParameterType getType()
type
type
public boolean isOptional()
optional
optional
public void setOptional(boolean pOptional)
optional
pOptional
- New value for attribute optional
public String getTooltip()
tooltip
tooltip
public void setTooltip(String pTooltip)
tooltip
pTooltip
- New value for attribute tooltip
public Object[] getPossibleValues()
possibleValues
possibleValues
public boolean isUsedForConnection()
usedForConnection
usedForConnection
public void setUsedForConnection(boolean pUsedForConnection)
usedForConnection
pUsedForConnection
- New value for attribute usedForConnection
Copyright © 2017 LightySoft. All rights reserved. [LogMX v6.0.2 (November 20, 2017)]