com.googlecode.jmxtrans.model

Class Query

java.lang.Object

com.googlecode.jmxtrans.model.Query

@ThreadSafe
@Immutable
public class Query
extends Object

Represents a JMX Query to ask for obj, attr and one or more keys.

Author:

jon

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Query.Builder

Constructor Summary

Constructors

Constructor and Description
Query(String obj, List<String> keys, List<String> attr, Set<String> typeNames, String resultAlias, boolean useObjDomainAsKey, boolean allowDottedKeys, List<OutputWriter> outputWriters)

Method Summary

Methods

Modifier and Type	Method and Description
static Query.Builder	builder()
boolean	equals(Object o)
com.google.common.collect.ImmutableList<String>	getAttr()
com.google.common.collect.ImmutableList<String>	getKeys()
String	getObj() The JMX object representation: java.lang:type=Memory
com.google.common.collect.ImmutableList<OutputWriter>	getOutputWriters()
String	getResultAlias() The alias allows you to specify what you would like the results of the query to go into.
com.google.common.collect.ImmutableSet<String>	getTypeNames() The list of type names used in a JMX bean string when querying with a wildcard which is used to expose the actual type name value to the key string.
int	hashCode()
boolean	isAllowDottedKeys()
boolean	isUseObjDomainAsKey() The useObjDomainAsKey property allows you to specify the use of the Domain portion of the Object Name as part of the output key instead of using the ClassName of the MBean which is the default behavior.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Query

public Query(String obj,
     List<String> keys,
     List<String> attr,
     Set<String> typeNames,
     String resultAlias,
     boolean useObjDomainAsKey,
     boolean allowDottedKeys,
     List<OutputWriter> outputWriters)

Method Detail

getObj

public String getObj()

The JMX object representation: java.lang:type=Memory

getResultAlias

public String getResultAlias()

The alias allows you to specify what you would like the results of the query to go into.

isUseObjDomainAsKey

public boolean isUseObjDomainAsKey()

The useObjDomainAsKey property allows you to specify the use of the Domain portion of the Object Name as part of the output key instead of using the ClassName of the MBean which is the default behavior.

getTypeNames

public com.google.common.collect.ImmutableSet<String> getTypeNames()

The list of type names used in a JMX bean string when querying with a wildcard which is used to expose the actual type name value to the key string. e.g. for this JMX name

typeName=name=PS Eden Space,type=MemoryPool

If you add a typeName("name"), then it'll retrieve 'PS Eden Space' from the string

getAttr

@Nonnull
public com.google.common.collect.ImmutableList<String> getAttr()

getKeys

@Nonnull
public com.google.common.collect.ImmutableList<String> getKeys()

isAllowDottedKeys

public boolean isAllowDottedKeys()

getOutputWriters

@Nonnull
public com.google.common.collect.ImmutableList<OutputWriter> getOutputWriters()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

builder

public static Query.Builder builder()