AgentCommand (PerfCake Agent API Documentation (version 6.2))

java.lang.Object
- java.lang.Enum<AgentCommand>
- - org.perfcake.agent.AgentCommand

All Implemented Interfaces:

Serializable, Comparable<AgentCommand>
```
public enum AgentCommand
extends Enum<AgentCommand>
```
PerfCake Agent command type.

Author:

Pavel Macík

Enum Constant Summary

Enum Constants
Enum Constant and Description
`DUMP` Initiates a heap dump in the Java Virtual Machine.
`FREE` Requests the amount of free memory in the Java Virtual Machine.
`GC` Calls `System.gc()` to perform a garbage collection.
`MAX` Requests the maximal amount of memory the Java Virtual Machine will attempt to use.
`TOTAL` Requests the amount of total memory in the Java Virtual Machine.
`USED` Requests the amount of used memory in the Java Virtual Machine.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static AgentCommand`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static AgentCommand[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - FREE
```
public static final AgentCommand FREE
```
    Requests the amount of free memory in the Java Virtual Machine.
  - USED
```
public static final AgentCommand USED
```
    Requests the amount of used memory in the Java Virtual Machine.
  - TOTAL
```
public static final AgentCommand TOTAL
```
    Requests the amount of total memory in the Java Virtual Machine.
  - MAX
```
public static final AgentCommand MAX
```
    Requests the maximal amount of memory the Java Virtual Machine will attempt to use.
  - DUMP
```
public static final AgentCommand DUMP
```
    Initiates a heap dump in the Java Virtual Machine.
  - GC
```
public static final AgentCommand GC
```
    Calls System.gc() to perform a garbage collection.
- Method Detail
  - values
```
public static AgentCommand[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (AgentCommand c : AgentCommand.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static AgentCommand valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null

Enum AgentCommand

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

FREE

USED

TOTAL

MAX

DUMP

GC

Method Detail

values

valueOf