com.appdynamics.instrumentation.sdk

Class Rule.Builder

java.lang.Object

com.appdynamics.instrumentation.sdk.Rule.Builder

Enclosing class:

Rule

public static class Rule.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder(java.lang.String classMatchString)

Method Summary

Modifier and Type	Method and Description
Rule.Builder	atField(java.lang.String name, boolean read, int occurrence) This method is used to define a field to instrument.
Rule.Builder	atLineNumber(int lineNum) This method is used to define a specific line number in the file to instrument.
Rule.Builder	atLocalVariable(java.lang.String name, boolean read, int occurrence) This method is used to define a local variable to instrument.
Rule.Builder	atMethodInvocation(java.lang.String name, int occurrence) This method is used to define a method invocation to instrument.
Rule	build() The method that returns a Rule object
Rule.Builder	classMatchType(SDKClassMatchType type)
Rule.Builder	classStringMatchType(SDKStringMatchType type)
Rule.Builder	collectLocalVariables(java.lang.String[] vars) This method is used to define what local variables you want to collect.
Rule.Builder	isAbsoluteLineNumber(boolean isAbsLineNum) This method is used to define whether the line number specified by atLineNumber(int) is an absolute line number or a relative line number relative to the start of the method.
Rule.Builder	isInstrumentBefore(boolean before) This method is used to define whether you are instrumenting before or after the specified point.
Rule.Builder	methodMatchString(java.lang.String string)
Rule.Builder	methodStringMatchType(SDKStringMatchType type)
Rule.Builder	withParams(java.lang.String... classNames) Specify the exact parameters to match.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(java.lang.String classMatchString)

Method Detail

classMatchType

public Rule.Builder classMatchType(SDKClassMatchType type)

classStringMatchType

public Rule.Builder classStringMatchType(SDKStringMatchType type)

methodStringMatchType

public Rule.Builder methodStringMatchType(SDKStringMatchType type)

methodMatchString

public Rule.Builder methodMatchString(java.lang.String string)

withParams

public Rule.Builder withParams(java.lang.String... classNames)

Specify the exact parameters to match. Needed for differentiating overloaded methods.

Parameters:

classNames - The fully qualified classnames of the parameters for the method being instrumented

Returns:

the Rule.Builder NOTE: If withParams(String...) is called for the builder, method match type is ignored and behave as though SDKStringMatchType.EQUALS is set.

atLineNumber

public Rule.Builder atLineNumber(int lineNum)

This method is used to define a specific line number in the file to instrument. This method can be used in conjunction with isAbsoluteLineNumber(boolean)

Parameters:

lineNum - the line number

Returns:

the builder for chained build.

See Also:

isAbsoluteLineNumber(boolean)

isAbsoluteLineNumber

public Rule.Builder isAbsoluteLineNumber(boolean isAbsLineNum)

This method is used to define whether the line number specified by atLineNumber(int) is an absolute line number or a relative line number relative to the start of the method. Note that the start of the method is the first "meaningful" instruction. Variable declaration, as opposed to instantiation, is not a "meaningful" instruction.

Parameters:

isAbsLineNum - true if the line number is absolute

Returns:

the builder for chained build.

atLocalVariable

public Rule.Builder atLocalVariable(java.lang.String name,
                                    boolean read,
                                    int occurrence)

This method is used to define a local variable to instrument.

Parameters:

name - the name of the local variable.

read - true if we are matching a local variable read, false for write.

occurrence - the number of occurrences of the local variable read or write.

Returns:

the builder for chained build.

atField

public Rule.Builder atField(java.lang.String name,
                            boolean read,
                            int occurrence)

This method is used to define a field to instrument.

Parameters:

name - the name of the field.

read - true if we are matching a field read, false for write.

occurrence - the number of occurrences of the field read or write.

Returns:

the builder for chained build.

atMethodInvocation

public Rule.Builder atMethodInvocation(java.lang.String name,
                                       int occurrence)

This method is used to define a method invocation to instrument.

Parameters:

name - the name of the method invoked.

occurrence - the number of times the method was invoked.

Returns:

the builder for chained build.

isInstrumentBefore

public Rule.Builder isInstrumentBefore(boolean before)

This method is used to define whether you are instrumenting before or after the specified point.

Parameters:

before - true if you are instrumenting before the point

Returns:

the builder for chained build.

collectLocalVariables

public Rule.Builder collectLocalVariables(java.lang.String[] vars)

This method is used to define what local variables you want to collect. Note that sometimes the local variable names gets changed by the compiler or obfuscator. As a result, some local variables cannot be collected.

Parameters:

vars - the array of local variable names

Returns:

the builder for changed build.

build

public Rule build()

The method that returns a Rule object

Returns:

the Rule object