JProbeDescription (GemFire XD Java API Documentation)

java.lang.Object
- hydra.AbstractDescription
- - hydra.JProbeDescription

All Implemented Interfaces:

Serializable
```
public class JProbeDescription
extends AbstractDescription
implements Serializable
```
Encodes information about a jprobe configuration.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

JProbeDescription()

Constructors
Constructor and Description
`JProbeDescription()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected static void`	`configure(TestConfig config)` Creates jprobe configuration descriptions from the jprobe parameters in the test configuration.
`String`	`getCommandLine(String jprobeHome, String vmType)` Returns jprobe command line, based on the values in this description, the provided jprobe home, and the vm type.
`Vector`	`getCommandLineParameters(String vmType)` Returns jprobe command line parameters, based on the values in this description and the vm type.
`String`	`getExecutable(String jprobeHome)` Returns jprobe executable, based on the provided jprobe home.
`Vector`	`getFilters()` Returns the set of filters.
`boolean`	`getFinalSnapshot()` Returns whether to take a final snapshot.
`String`	`getFunction()` Returns the function.
`boolean`	`getGarbageKeep()` Returns whether to keep garbage.
`String`	`getMeasurement()` Returns the measurement type.
`boolean`	`getMonitor()` Returns whether the user will monitor.
`String`	`getName()` Returns the logical name for the jprobe description.
`int`	`getPort()` Returns the port for this run.
`boolean`	`getRecordFromStart()` Returns whether to record from the start.
`boolean`	`getTrackObjects()` Returns whether to track object allocation
`Vector`	`getTriggers()` Returns the set of triggers.
`SortedMap`	`toSortedMap()` Returns a sorted map of description fields and their values.
`boolean`	`useDeepTraces()` Returns whether to use deep traces.

Methods inherited from class hydra.AbstractDescription
addProperties, asList, convertPrm, convertPrmDefault, getBooleanFor, getClass, getClassname, getInstance, getIntegerFor, getNonnegativeIntegerFor, getParametersAndDefaults, getPath, getSSLDescription, loadClass, parseMethod, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - JProbeDescription
```
public JProbeDescription()
```
- Method Detail
  - getName
```
public String getName()
```
    Returns the logical name for the jprobe description.
  - getFunction
```
public String getFunction()
```
    Returns the function.
  - getMeasurement
```
public String getMeasurement()
```
    Returns the measurement type.
  - getFilters
```
public Vector getFilters()
```
    Returns the set of filters.
  - getTriggers
```
public Vector getTriggers()
```
    Returns the set of triggers.
  - useDeepTraces
```
public boolean useDeepTraces()
```
    Returns whether to use deep traces.
  - getRecordFromStart
```
public boolean getRecordFromStart()
```
    Returns whether to record from the start.
  - getFinalSnapshot
```
public boolean getFinalSnapshot()
```
    Returns whether to take a final snapshot.
  - getTrackObjects
```
public boolean getTrackObjects()
```
    Returns whether to track object allocation
  - getMonitor
```
public boolean getMonitor()
```
    Returns whether the user will monitor.
  - getGarbageKeep
```
public boolean getGarbageKeep()
```
    Returns whether to keep garbage.
  - getPort
```
public int getPort()
```
    Returns the port for this run.
  - getCommandLine
```
public String getCommandLine(String jprobeHome,
                             String vmType)
```
    Returns jprobe command line, based on the values in this description, the provided jprobe home, and the vm type.
  - getExecutable
```
public String getExecutable(String jprobeHome)
```
    Returns jprobe executable, based on the provided jprobe home.
  - getCommandLineParameters
```
public Vector getCommandLineParameters(String vmType)
```
    Returns jprobe command line parameters, based on the values in this description and the vm type.
  - toSortedMap
```
public SortedMap toSortedMap()
```
    Description copied from class: AbstractDescription
    
    Returns a sorted map of description fields and their values.
    
    Specified by:
    
    toSortedMap in class AbstractDescription
  - configure
```
protected static void configure(TestConfig config)
```
    Creates jprobe configuration descriptions from the jprobe parameters in the test configuration.

Class JProbeDescription

Constructor Summary

Method Summary

Methods inherited from class hydra.AbstractDescription

Methods inherited from class java.lang.Object

Constructor Detail

JProbeDescription

Method Detail

getName

getFunction

getMeasurement

getFilters

getTriggers

useDeepTraces

getRecordFromStart

getFinalSnapshot

getTrackObjects

getMonitor

getGarbageKeep

getPort

getCommandLine

getExecutable

getCommandLineParameters

toSortedMap

configure