AgentConfigs (GZoltar 1.7.2 API)

java.lang.Object
- com.gzoltar.core.AgentConfigs

```
public final class AgentConfigs
extends Object
```
Utility to create and parse configurations for the runtime agent. Configurations are represented as a string in the following format:
```
   key1=value1,key2=value2,key3=value3
 
```
DISCLAIMER: this class has been exported from JaCoCo's core module (originally called org.jacoco.core.runtime.AgentOptions) and augmented. In here, it would be desirable to extend JaCoCo's class (using the extends keyword) rather than including a very similar one, however JaCoCo's class is final (as all it's fields) and therefore cannot be extended/augmented.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BUILDLOCATION_KEY`
`static String`	`DEFAULT_BUILDLOCATION`
`static String`	`DEFAULT_DESTFILE` Default value for the "destfile" agent configuration.
`static String`	`DEFAULT_EXCLCLASSLOADER`
`static String`	`DEFAULT_EXCLUDES`
`static GranularityLevel`	`DEFAULT_GRANULARITY`
`static boolean`	`DEFAULT_INCLDEPRECATEDMETHODS`
`static boolean`	`DEFAULT_INCLNOLOCATIONCLASSES`
`static boolean`	`DEFAULT_INCLPUBLICMETHODS`
`static boolean`	`DEFAULT_INCLSTATICCONSTRUCTORS`
`static String`	`DEFAULT_INCLUDES`
`static InstrumentationLevel`	`DEFAULT_INSTRUMENTATION_LEVEL`
`static AgentOutput`	`DEFAULT_OUTPUT`
`static String`	`DESTFILE_KEY` Specifies the output file for execution data.
`static String`	`EXCLCLASSLOADER_KEY` Wildcard expression for class loaders names for classes that should be excluded from code coverage.
`static String`	`EXCLUDES_KEY` Wildcard expression for class names that should be excluded from code coverage.
`static String`	`GRANULARITY_KEY` Specifies the granularity level of instrumentation.
`static String`	`INCLDEPRECATEDMETHODS_KEY` Specifies whether methods annotated with @deprecated of each class under test should be instrumented.
`static String`	`INCLNOLOCATIONCLASSES_KEY` Specifies whether also classes without a source location should be instrumented.
`static String`	`INCLPUBLICMETHODS_KEY` Specifies whether public methods of each class under test should be instrumented.
`static String`	`INCLSTATICCONSTRUCTORS_KEY` Specifies whether public static constructors of each class under test should be instrumented.
`static String`	`INCLUDES_KEY` Wildcard expression for class names that should be included for code coverage.
`static String`	`INSTRUMENTATION_LEVEL_KEY` Specifies which level of instrumentation should be performed.
`static String`	`OUTPUT_KEY` Specifies the output mode.

Constructor Summary

Constructors
Constructor and Description
`AgentConfigs()` New instance with all values set to default.
`AgentConfigs(Properties properties)` New instance read from the given `Properties` object.
`AgentConfigs(String agentConfigs)` New instance parsed from the given configuration string.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getBuildLocation()` Returns the build location.
`String`	`getDestfile()` Returns the output file location.
`String`	`getExclClassloader()` Returns the wildcard expression for excluded class loaders.
`String`	`getExcludes()` Returns the wildcard expression for classes to exclude.
`GranularityLevel`	`getGranularity()` Returns the granularity level
`Boolean`	`getInclDeprecatedMethods()` Returns whether methods annotated with @deprecated should be instrumented.
`boolean`	`getInclNoLocationClasses()` Returns whether classes without source location should be instrumented.
`Boolean`	`getInclPublicMethods()` Returns whether public methods should be instrumented.
`Boolean`	`getInclStaticConstructors()` Returns whether public static constructors should be instrumented.
`String`	`getIncludes()` Returns the wildcard expression for classes to include.
`InstrumentationLevel`	`getInstrumentationLevel()` Returns which instrumentation level should be performed.
`AgentOutput`	`getOutput()` Returns the output mode
`String`	`getQuotedVMArgument(File agentJarFile)` Generate required quoted JVM argument based on current configuration and supplied agent jar location.
`String`	`getVMArgument(File agentJarFile)` Generate required JVM argument based on current configuration and supplied agent jar location.
`String`	`prependVMArguments(String arguments, File agentJarFile)` Generate required quotes JVM argument based on current configuration and prepends it to the given argument command line.
`void`	`setBuildLocation(String buildLocation)` Set the build location.
`void`	`setDestfile(String destfile)` Sets the output file location.
`void`	`setExclClassloader(String expression)` Sets the wildcard expression for excluded class loaders.
`void`	`setExcludes(String excludes)` Sets the wildcard expression for classes to exclude.
`void`	`setGranularity(GranularityLevel granularity)` Sets the granularity level
`void`	`setGranularity(String granularity)` Sets the granularity level
`void`	`setInclDeprecatedMethods(boolean inclDeprecatedMethods)` Sets whether methods annotated with @deprecated should be instrumented.
`void`	`setInclNoLocationClasses(boolean include)` Sets whether classes without source location should be instrumented.
`void`	`setInclPublicMethods(boolean inclPublicMethods)` Sets whether public methods should be instrumented.
`void`	`setInclStaticConstructors(boolean inclStaticConstructors)` Sets whether public static constructors should be instrumented.
`void`	`setIncludes(String includes)` Sets the wildcard expression for classes to include.
`void`	`setInstrumentationLevel(InstrumentationLevel instrumentationLevel)` Sets which instrumentation level should be performed.
`void`	`setInstrumentationLevel(String instrumentationLevel)` Sets which instrumentation level should be performed.
`void`	`setOutput(AgentOutput output)` Sets the output mode
`void`	`setOutput(String output)` Sets the output mode
`String`	`toString()` Creates a string representation that can be passed to the agent via the command line.

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

- Field Detail
  - BUILDLOCATION_KEY
```
public static final String BUILDLOCATION_KEY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_BUILDLOCATION
```
public static final String DEFAULT_BUILDLOCATION
```
    See Also:
    
    Constant Field Values
  - DESTFILE_KEY
```
public static final String DESTFILE_KEY
```
    Specifies the output file for execution data. Default is gzoltar.ser in the working directory.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DESTFILE
```
public static final String DEFAULT_DESTFILE
```
    Default value for the "destfile" agent configuration.
    
    See Also:
    
    Constant Field Values
  - INCLUDES_KEY
```
public static final String INCLUDES_KEY
```
    Wildcard expression for class names that should be included for code coverage. Default is * (all classes included).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_INCLUDES
```
public static final String DEFAULT_INCLUDES
```
    See Also:
    
    Constant Field Values
  - EXCLUDES_KEY
```
public static final String EXCLUDES_KEY
```
    Wildcard expression for class names that should be excluded from code coverage. Default is the empty string (no exclusions).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_EXCLUDES
```
public static final String DEFAULT_EXCLUDES
```
    See Also:
    
    Constant Field Values
  - EXCLCLASSLOADER_KEY
```
public static final String EXCLCLASSLOADER_KEY
```
    Wildcard expression for class loaders names for classes that should be excluded from code coverage. This means all classes loaded by a class loader which full qualified name matches this expression will be ignored for code coverage regardless of all other filtering settings. Default is sun.reflect.DelegatingClassLoader.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_EXCLCLASSLOADER
```
public static final String DEFAULT_EXCLCLASSLOADER
```
    See Also:
    
    Constant Field Values
  - INCLNOLOCATIONCLASSES_KEY
```
public static final String INCLNOLOCATIONCLASSES_KEY
```
    Specifies whether also classes without a source location should be instrumented. Normally such classes are generated at runtime e.g. by mocking frameworks and are therefore excluded by default. Default is false.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_INCLNOLOCATIONCLASSES
```
public static final boolean DEFAULT_INCLNOLOCATIONCLASSES
```
    See Also:
    
    Constant Field Values
  - OUTPUT_KEY
```
public static final String OUTPUT_KEY
```
    Specifies the output mode. Default is OutputMode#file.
    
    See Also:
    
    OutputMode#file, OutputMode#console, OutputMode#none, Constant Field Values
  - DEFAULT_OUTPUT
```
public static final AgentOutput DEFAULT_OUTPUT
```
  - GRANULARITY_KEY
```
public static final String GRANULARITY_KEY
```
    Specifies the granularity level of instrumentation. Default is GranularityLevel#line.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_GRANULARITY
```
public static final GranularityLevel DEFAULT_GRANULARITY
```
  - INCLPUBLICMETHODS_KEY
```
public static final String INCLPUBLICMETHODS_KEY
```
    Specifies whether public methods of each class under test should be instrumented. Default is true.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_INCLPUBLICMETHODS
```
public static final boolean DEFAULT_INCLPUBLICMETHODS
```
    See Also:
    
    Constant Field Values
  - INCLSTATICCONSTRUCTORS_KEY
```
public static final String INCLSTATICCONSTRUCTORS_KEY
```
    Specifies whether public static constructors of each class under test should be instrumented. Default is true.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_INCLSTATICCONSTRUCTORS
```
public static final boolean DEFAULT_INCLSTATICCONSTRUCTORS
```
    See Also:
    
    Constant Field Values
  - INCLDEPRECATEDMETHODS_KEY
```
public static final String INCLDEPRECATEDMETHODS_KEY
```
    Specifies whether methods annotated with @deprecated of each class under test should be instrumented. Default is true.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_INCLDEPRECATEDMETHODS
```
public static final boolean DEFAULT_INCLDEPRECATEDMETHODS
```
    See Also:
    
    Constant Field Values
  - INSTRUMENTATION_LEVEL_KEY
```
public static final String INSTRUMENTATION_LEVEL_KEY
```
    Specifies which level of instrumentation should be performed. Default is full.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_INSTRUMENTATION_LEVEL
```
public static final InstrumentationLevel DEFAULT_INSTRUMENTATION_LEVEL
```
- Constructor Detail
  - AgentConfigs
```
public AgentConfigs()
```
    New instance with all values set to default.
  - AgentConfigs
```
public AgentConfigs(String agentConfigs)
```
    New instance parsed from the given configuration string.
    
    Parameters:
    
    agentConfigs - string to parse or null
  - AgentConfigs
```
public AgentConfigs(Properties properties)
```
    New instance read from the given Properties object.
    
    Parameters:
    
    properties - Properties object to read configuration options from
- Method Detail
  - getBuildLocation
```
public String getBuildLocation()
```
    Returns the build location.
    
    Returns:
    
    build directory location
  - setBuildLocation
```
public void setBuildLocation(String buildLocation)
```
    Set the build location.
    
    Parameters:
    
    buildLocation - directory location
  - getDestfile
```
public String getDestfile()
```
    Returns the output file location.
    
    Returns:
    
    output file location
  - setDestfile
```
public void setDestfile(String destfile)
```
    Sets the output file location.
    
    Parameters:
    
    destfile - output file location
  - getIncludes
```
public String getIncludes()
```
    Returns the wildcard expression for classes to include.
    
    Returns:
    
    wildcard expression for classes to include
  - setIncludes
```
public void setIncludes(String includes)
```
    Sets the wildcard expression for classes to include.
    
    Parameters:
    
    includes - wildcard expression for classes to include
  - getExcludes
```
public String getExcludes()
```
    Returns the wildcard expression for classes to exclude.
    
    Returns:
    
    wildcard expression for classes to exclude
  - setExcludes
```
public void setExcludes(String excludes)
```
    Sets the wildcard expression for classes to exclude.
    
    Parameters:
    
    excludes - wildcard expression for classes to exclude
  - getExclClassloader
```
public String getExclClassloader()
```
    Returns the wildcard expression for excluded class loaders.
    
    Returns:
    
    expression for excluded class loaders
  - setExclClassloader
```
public void setExclClassloader(String expression)
```
    Sets the wildcard expression for excluded class loaders.
    
    Parameters:
    
    expression - expression for excluded class loaders
  - getInclNoLocationClasses
```
public boolean getInclNoLocationClasses()
```
    Returns whether classes without source location should be instrumented.
    
    Returns:
    
    true if classes without source location should be instrumented
  - setInclNoLocationClasses
```
public void setInclNoLocationClasses(boolean include)
```
    Sets whether classes without source location should be instrumented.
    
    Parameters:
    
    include - true if classes without source location should be instrumented
  - getOutput
```
public AgentOutput getOutput()
```
    Returns the output mode
    
    Returns:
    
    current output mode
  - setOutput
```
public void setOutput(String output)
```
    Sets the output mode
    
    Parameters:
    
    output - Output mode
  - setOutput
```
public void setOutput(AgentOutput output)
```
    Sets the output mode
    
    Parameters:
    
    output - Output mode
  - getGranularity
```
public GranularityLevel getGranularity()
```
    Returns the granularity level
    
    Returns:
    
    current granularity level
  - setGranularity
```
public void setGranularity(String granularity)
```
    Sets the granularity level
    
    Parameters:
    
    granularity - Granularity level
  - setGranularity
```
public void setGranularity(GranularityLevel granularity)
```
    Sets the granularity level
    
    Parameters:
    
    granularity - Granularity level
  - getInclPublicMethods
```
public Boolean getInclPublicMethods()
```
    Returns whether public methods should be instrumented.
    
    Returns:
    
    true if public methods should be instrumented
  - setInclPublicMethods
```
public void setInclPublicMethods(boolean inclPublicMethods)
```
    Sets whether public methods should be instrumented.
    
    Parameters:
    
    inclPublicMethods - true if public methods should be instrumented
  - getInclStaticConstructors
```
public Boolean getInclStaticConstructors()
```
    Returns whether public static constructors should be instrumented.
    
    Returns:
    
    true if public static constructors should be instrumented
  - setInclStaticConstructors
```
public void setInclStaticConstructors(boolean inclStaticConstructors)
```
    Sets whether public static constructors should be instrumented.
    
    Parameters:
    
    inclPublicMethods - true if public static constructors should be instrumented
  - getInclDeprecatedMethods
```
public Boolean getInclDeprecatedMethods()
```
    Returns whether methods annotated with @deprecated should be instrumented.
    
    Returns:
    
    true if methods annotated with @deprecated should be instrumented
  - setInclDeprecatedMethods
```
public void setInclDeprecatedMethods(boolean inclDeprecatedMethods)
```
    Sets whether methods annotated with @deprecated should be instrumented.
    
    Parameters:
    
    inclDeprecatedMethods - true if methods annotated with @deprecated should be instrumented
  - getInstrumentationLevel
```
public InstrumentationLevel getInstrumentationLevel()
```
    Returns which instrumentation level should be performed.
    
    Returns:
    
    instrumentationLevel
  - setInstrumentationLevel
```
public void setInstrumentationLevel(String instrumentationLevel)
```
    Sets which instrumentation level should be performed.
    
    Parameters:
    
    instrumentationLevel -
  - setInstrumentationLevel
```
public void setInstrumentationLevel(InstrumentationLevel instrumentationLevel)
```
    Sets which instrumentation level should be performed.
    
    Parameters:
    
    instrumentationLevel -
  - getVMArgument
```
public String getVMArgument(File agentJarFile)
```
    Generate required JVM argument based on current configuration and supplied agent jar location.
    
    Parameters:
    
    agentJarFile - location of the GZoltar Agent Jar
    
    Returns:
    
    Argument to pass to create new VM with coverage enabled
  - getQuotedVMArgument
```
public String getQuotedVMArgument(File agentJarFile)
```
    Generate required quoted JVM argument based on current configuration and supplied agent jar location.
    
    Parameters:
    
    agentJarFile - location of the GZoltar Agent Jar
    
    Returns:
    
    Quoted argument to pass to create new VM with coverage enabled
  - prependVMArguments
```
public String prependVMArguments(String arguments,
                                 File agentJarFile)
```
    Generate required quotes JVM argument based on current configuration and prepends it to the given argument command line. If a agent with the same JAR file is already specified this parameter is removed from the existing command line.
    
    Parameters:
    
    arguments - existing command line arguments or null
    
    agentJarFile - location of the GZoltar Agent Jar
    
    Returns:
    
    VM command line arguments prepended with configured GZoltar agent
  - toString
```
public String toString()
```
    Creates a string representation that can be passed to the agent via the command line. Might be the empty string, if no configurations are set.
    
    Overrides:
    
    toString in class Object

Class AgentConfigs

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BUILDLOCATION_KEY

DEFAULT_BUILDLOCATION

DESTFILE_KEY

DEFAULT_DESTFILE

INCLUDES_KEY

DEFAULT_INCLUDES

EXCLUDES_KEY

DEFAULT_EXCLUDES

EXCLCLASSLOADER_KEY

DEFAULT_EXCLCLASSLOADER

INCLNOLOCATIONCLASSES_KEY

DEFAULT_INCLNOLOCATIONCLASSES

OUTPUT_KEY

DEFAULT_OUTPUT

GRANULARITY_KEY

DEFAULT_GRANULARITY

INCLPUBLICMETHODS_KEY

DEFAULT_INCLPUBLICMETHODS

INCLSTATICCONSTRUCTORS_KEY

DEFAULT_INCLSTATICCONSTRUCTORS

INCLDEPRECATEDMETHODS_KEY

DEFAULT_INCLDEPRECATEDMETHODS

INSTRUMENTATION_LEVEL_KEY

DEFAULT_INSTRUMENTATION_LEVEL

Constructor Detail

AgentConfigs

AgentConfigs

AgentConfigs

Method Detail

getBuildLocation

setBuildLocation

getDestfile

setDestfile

getIncludes

setIncludes

getExcludes

setExcludes

getExclClassloader

setExclClassloader

getInclNoLocationClasses

setInclNoLocationClasses

getOutput

setOutput

setOutput

getGranularity

setGranularity

setGranularity

getInclPublicMethods

setInclPublicMethods

getInclStaticConstructors

setInclStaticConstructors

getInclDeprecatedMethods

setInclDeprecatedMethods

getInstrumentationLevel

setInstrumentationLevel

setInstrumentationLevel

getVMArgument

getQuotedVMArgument

prependVMArguments

toString