|
Apache JMeter | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.jmeter.testelement.AbstractTestElement org.apache.jmeter.protocol.http.modifier.ParamMask
public class ParamMask
This object defines with what a parameter has its value replaced, and the
policies for how that value changes. Used in ParamModifier
.
Field Summary |
---|
Fields inherited from interface org.apache.jmeter.testelement.TestElement |
---|
COMMENTS, ENABLED, GUI_CLASS, NAME, TEST_CLASS |
Constructor Summary | |
---|---|
ParamMask()
Default constructor. |
Method Summary | |
---|---|
String |
getFieldName()
|
long |
getIncrement()
Accessor method, returns the number by which the parameter value is incremented between loops. |
long |
getLowerBound()
Accessor method, returns the lowest possible value that the long portion of the parameter value may be. |
String |
getNextValue()
Returns the current value, prefixed and suffixed, as a string, then increments it. |
String |
getPrefix()
Accessor method to return the String that will be prefixed
to the long value. |
String |
getSuffix()
Accessor method to return the String that will be suffixed
to the long value. |
long |
getUpperBound()
Accessor method, returns the highest possible value that the long portion of the parameter value may be. |
void |
resetValue()
This method determines the policy of what value to start (and re-start) at. |
void |
setFieldName(String fieldName)
|
void |
setIncrement(long incr)
Sets the number by which the parameter value is incremented between loops. |
void |
setLowerBound(long val)
Sets the lowest possible value that the long portion of
the parameter value may be. |
void |
setPrefix(String prefix)
Sets the prefix for the long value. |
void |
setSuffix(String suffix)
Sets the suffix for the long value. |
void |
setUpperBound(long val)
Sets the highest possible value that the long portion of
the parameter value may be. |
void |
setValue(long val)
Set the current value of the long |
String |
toString()
For debugging purposes. |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ParamMask()
Method Detail |
---|
public void setPrefix(String prefix)
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.
prefix
- a string to prefix to the parameter valuepublic void setValue(long val)
long portion of the parameter
value to replace. This is usually not used, as the method
resetValue()
is used to define a policy for the starting value.
- Parameters:
val
- the new parameter value
public void setFieldName(String fieldName)
public void setLowerBound(long val)
long
portion of
the parameter value may be.
val
- the new lowest possible parameter valuepublic void setUpperBound(long val)
long
portion of
the parameter value may be.
val
- the new highest possible parameter valuepublic void setIncrement(long incr)
incr
- the new increment for the parameter valuepublic void setSuffix(String suffix)
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.
suffix
- a string to suffix to the parameter valuepublic String getPrefix()
String
that will be prefixed
to the long
value.
public long getLowerBound()
long
portion of the parameter value may be.
public long getUpperBound()
long
portion of the parameter value may be.
public long getIncrement()
public String getSuffix()
String
that will be suffixed
to the long
value.
public String getNextValue()
This method determines the policy of what happens when an upper bound is reached/surpassed.
String
representing the current
long
valuepublic void resetValue()
public String getFieldName()
public String toString()
toString
in class Object
String
representing the object
|
Apache JMeter | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |