| java.lang.Object
 org.apache.jmeter.testelement.AbstractTestElement
org.apache.jmeter.protocol.http.modifier.ParamMask
| ParamMask | | public class ParamMask extends AbstractTestElement implements Serializable(Code) | | This object defines with what a parameter has its value replaced, and the
policies for how that value changes. Used in
ParamModifier .
author:
David La France
author:
Scott Eade
version:
$Revision: 493789 $ updated on $Date: 2007-01-07 18:10:21 +0000 (Sun, 07 Jan 2007) $ |
| Constructor Summary | |
| public | ParamMask()
Default constructor. |
| Method Summary | |
| public String | getFieldName()
| | public long | getIncrement()
Accessor method, returns the number by which the parameter value is
incremented between loops. | | public long | getLowerBound()
Accessor method, returns the lowest possible value that the
long portion of the parameter value may be. | | public String | getNextValue()
Returns the current value, prefixed and suffixed, as a string, then
increments it. | | public String | getPrefix()
Accessor method to return the String that will be prefixed
to the long value. | | public String | getSuffix()
Accessor method to return the String that will be suffixed
to the long value. | | public long | getUpperBound()
Accessor method, returns the highest possible value that the
long portion of the parameter value may be. | | public void | resetValue()
This method determines the policy of what value to start (and re-start)
at. | | public void | setFieldName(String fieldName)
| | public void | setIncrement(long incr)
Sets the number by which the parameter value is incremented between
loops. | | public void | setLowerBound(long val)
Sets the lowest possible value that the long portion of
the parameter value may be. | | public void | setPrefix(String prefix)
Sets the prefix for the long value. | | public void | setSuffix(String suffix)
Sets the suffix for the long value. | | public void | setUpperBound(long val)
Sets the highest possible value that the long portion of
the parameter value may be. | | public void | setValue(long val)
Set the current value of the long portion of the parameter
value to replace. | | public String | toString()
For debugging purposes. |
| ParamMask | | public ParamMask()(Code) | | Default constructor.
|
| getIncrement | | public long getIncrement()(Code) | | Accessor method, returns the number by which the parameter value is
incremented between loops.
the increment |
| getLowerBound | | public long getLowerBound()(Code) | | Accessor method, returns the lowest possible value that the
long portion of the parameter value may be.
the lower bound of the possible values |
| getNextValue | | public String getNextValue()(Code) | | Returns the current value, prefixed and suffixed, as a string, then
increments it. If the incremented value is above the upper bound, the
value is reset to the lower bound.
This method determines the policy of what happens when an upper bound is
reached/surpassed.
a String representing the currentlong value |
| getPrefix | | public String getPrefix()(Code) | | Accessor method to return the String that will be prefixed
to the long value.
the parameter value prefix |
| getSuffix | | public String getSuffix()(Code) | | Accessor method to return the String that will be suffixed
to the long value.
the parameter value suffix |
| getUpperBound | | public long getUpperBound()(Code) | | Accessor method, returns the highest possible value that the
long portion of the parameter value may be.
the higher bound of the possible values |
| resetValue | | public void resetValue()(Code) | | This method determines the policy of what value to start (and re-start)
at.
|
| setFieldName | | public void setFieldName(String fieldName)(Code) | | |
| setIncrement | | public void setIncrement(long incr)(Code) | | Sets the number by which the parameter value is incremented between
loops.
Parameters:
incr - the new increment for the parameter value |
| setLowerBound | | public void setLowerBound(long val)(Code) | | Sets the lowest possible value that the long portion of
the parameter value may be.
Parameters:
val - the new lowest possible parameter value |
| setPrefix | | public void setPrefix(String prefix)(Code) | | Sets the prefix for the long value. The prefix, the value
and the suffix are concatenated to give the parameter value. This allows
a wider range of posibilities for the parameter values.
Parameters:
prefix - a string to prefix to the parameter value |
| setSuffix | | public void setSuffix(String suffix)(Code) | | Sets the suffix for the long value. The prefix, the value
and the suffix are concatenated to give the parameter value. This allows
a wider range of posibilities for the parameter values.
Parameters:
suffix - a string to suffix to the parameter value |
| setUpperBound | | public void setUpperBound(long val)(Code) | | Sets the highest possible value that the long portion of
the parameter value may be.
Parameters:
val - the new highest possible parameter value |
| setValue | | public void setValue(long val)(Code) | | Set the current value of the long portion of the parameter
value to replace. This is usually not used, as the method
ParamMask.resetValue is used to define a policy for the starting value.
Parameters:
val - the new parameter value |
| toString | | public String toString()(Code) | | For debugging purposes.
a String representing the object |
|
|