public class

Query

extends Object
java.lang.Object
   ↳ javax.management.Query

Class Overview

Constructs query object constraints. The static methods provided return query expressions that may be used in listing and enumerating MBeans. Individual constraint construction methods allow only appropriate types as arguments. Composition of calls can construct arbitrary nestings of constraints, as the following example illustrates:

 QueryExp exp = Query.and(Query.gt(Query.attr("age"),Query.value(5)),
                          Query.match(Query.attr("name"),
                                      Query.value("Smith")));

Summary

Constants
int DIV A code representing the div(ValueExp, ValueExp) expression.
int EQ A code representing the eq(ValueExp, ValueExp) query.
int GE A code representing the geq(ValueExp, ValueExp) query.
int GT A code representing the gt(ValueExp, ValueExp) query.
int LE A code representing the leq(ValueExp, ValueExp) query.
int LT A code representing the lt(ValueExp, ValueExp) query.
int MINUS A code representing the minus(ValueExp, ValueExp) expression.
int PLUS A code representing the plus(ValueExp, ValueExp) expression.
int TIMES A code representing the times(ValueExp, ValueExp) expression.
Public Constructors
Query()
Basic constructor.
Public Methods
static QueryExp and(QueryExp q1, QueryExp q2)
Returns a query expression that is the conjunction of two other query expressions.
static QueryExp anySubString(AttributeValueExp a, StringValueExp s)
Returns a query expression that represents a matching constraint on a string argument.
static AttributeValueExp attr(String className, String name)

Returns a new qualified attribute expression.

static AttributeValueExp attr(String name)

Returns a new attribute expression.

static QueryExp between(ValueExp v1, ValueExp v2, ValueExp v3)
Returns a query expression that represents the constraint that one value is between two other values.
static AttributeValueExp classattr()

Returns a new class attribute expression which can be used in any Query call that expects a ValueExp.

static ValueExp div(ValueExp value1, ValueExp value2)
Returns a binary expression representing the quotient of two numeric values.
static QueryExp eq(ValueExp v1, ValueExp v2)
Returns a query expression that represents an equality constraint on two values.
static QueryExp finalSubString(AttributeValueExp a, StringValueExp s)
Returns a query expression that represents a matching constraint on a string argument.
static QueryExp geq(ValueExp v1, ValueExp v2)
Returns a query expression that represents a "greater than or equal to" constraint on two values.
static QueryExp gt(ValueExp v1, ValueExp v2)
Returns a query expression that represents a "greater than" constraint on two values.
static QueryExp in(ValueExp val, ValueExp[] valueList)
Returns an expression constraining a value to be one of an explicit list.
static QueryExp initialSubString(AttributeValueExp a, StringValueExp s)
Returns a query expression that represents a matching constraint on a string argument.
static QueryExp isInstanceOf(StringValueExp classNameValue)
Returns a query expression that represents an inheritance constraint on an MBean class.
static QueryExp leq(ValueExp v1, ValueExp v2)
Returns a query expression that represents a "less than or equal to" constraint on two values.
static QueryExp lt(ValueExp v1, ValueExp v2)
Returns a query expression that represents a "less than" constraint on two values.
static QueryExp match(AttributeValueExp a, StringValueExp s)
Returns a query expression that represents a matching constraint on a string argument.
static ValueExp minus(ValueExp value1, ValueExp value2)
Returns a binary expression representing the difference between two numeric values.
static QueryExp not(QueryExp queryExp)
Returns a constraint that is the negation of its argument.
static QueryExp or(QueryExp q1, QueryExp q2)
Returns a query expression that is the disjunction of two other query expressions.
static ValueExp plus(ValueExp value1, ValueExp value2)
Returns a binary expression representing the sum of two numeric values, or the concatenation of two string values.
static ValueExp times(ValueExp value1, ValueExp value2)
Returns a binary expression representing the product of two numeric values.
static ValueExp value(double val)
Returns a numeric value expression that can be used in any Query call that expects a ValueExp.
static ValueExp value(long val)
Returns a numeric value expression that can be used in any Query call that expects a ValueExp.
static ValueExp value(boolean val)
Returns a boolean value expression that can be used in any Query call that expects a ValueExp.
static ValueExp value(float val)
Returns a numeric value expression that can be used in any Query call that expects a ValueExp.
static ValueExp value(int val)
Returns a numeric value expression that can be used in any Query call that expects a ValueExp.
static ValueExp value(Number val)
Returns a numeric value expression that can be used in any Query call that expects a ValueExp.
static StringValueExp value(String val)
Returns a new string expression.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int DIV

A code representing the div(ValueExp, ValueExp) expression. This is chiefly of interest for the serialized form of queries.

Constant Value: 3 (0x00000003)

public static final int EQ

A code representing the eq(ValueExp, ValueExp) query. This is chiefly of interest for the serialized form of queries.

Constant Value: 4 (0x00000004)

public static final int GE

A code representing the geq(ValueExp, ValueExp) query. This is chiefly of interest for the serialized form of queries.

Constant Value: 2 (0x00000002)

public static final int GT

A code representing the gt(ValueExp, ValueExp) query. This is chiefly of interest for the serialized form of queries.

Constant Value: 0 (0x00000000)

public static final int LE

A code representing the leq(ValueExp, ValueExp) query. This is chiefly of interest for the serialized form of queries.

Constant Value: 3 (0x00000003)

public static final int LT

A code representing the lt(ValueExp, ValueExp) query. This is chiefly of interest for the serialized form of queries.

Constant Value: 1 (0x00000001)

public static final int MINUS

A code representing the minus(ValueExp, ValueExp) expression. This is chiefly of interest for the serialized form of queries.

Constant Value: 1 (0x00000001)

public static final int PLUS

A code representing the plus(ValueExp, ValueExp) expression. This is chiefly of interest for the serialized form of queries.

Constant Value: 0 (0x00000000)

public static final int TIMES

A code representing the times(ValueExp, ValueExp) expression. This is chiefly of interest for the serialized form of queries.

Constant Value: 2 (0x00000002)

Public Constructors

public Query ()

Basic constructor.

Public Methods

public static QueryExp and (QueryExp q1, QueryExp q2)

Returns a query expression that is the conjunction of two other query expressions.

Parameters
q1 A query expression.
q2 Another query expression.
Returns
  • The conjunction of the two arguments. The returned object will be serialized as an instance of the non-public class javax.management.AndQueryExp.

public static QueryExp anySubString (AttributeValueExp a, StringValueExp s)

Returns a query expression that represents a matching constraint on a string argument. The value must contain the given literal string value.

Parameters
a An attribute expression.
s A string value expression representing the substring.
Returns

public static AttributeValueExp attr (String className, String name)

Returns a new qualified attribute expression.

Evaluating this expression for a given objectName includes performing MBeanServer.getObjectInstance(objectName) and MBeanServer.getAttribute(objectName, name).

Parameters
className The name of the class possessing the attribute.
name The name of the attribute.
Returns

public static AttributeValueExp attr (String name)

Returns a new attribute expression.

Evaluating this expression for a given objectName includes performing MBeanServer.getAttribute(objectName, name).

Parameters
name The name of the attribute.
Returns
  • An attribute expression for the attribute named name.

public static QueryExp between (ValueExp v1, ValueExp v2, ValueExp v3)

Returns a query expression that represents the constraint that one value is between two other values.

Parameters
v1 A value expression that is "between" v2 and v3.
v2 Value expression that represents a boundary of the constraint.
v3 Value expression that represents a boundary of the constraint.
Returns

public static AttributeValueExp classattr ()

Returns a new class attribute expression which can be used in any Query call that expects a ValueExp.

Evaluating this expression for a given objectName includes performing MBeanServer.getObjectInstance(objectName).

Returns

public static ValueExp div (ValueExp value1, ValueExp value2)

Returns a binary expression representing the quotient of two numeric values.

Parameters
value1 The first '/' operand.
value2 The second '/' operand.
Returns
  • A ValueExp representing the quotient of two arguments. The returned object will be serialized as an instance of the non-public class javax.management.BinaryOpValueExp with an op equal to DIV.

public static QueryExp eq (ValueExp v1, ValueExp v2)

Returns a query expression that represents an equality constraint on two values.

Parameters
v1 A value expression.
v2 Another value expression.
Returns

public static QueryExp finalSubString (AttributeValueExp a, StringValueExp s)

Returns a query expression that represents a matching constraint on a string argument. The value must end with the given literal string value.

Parameters
a An attribute expression.
s A string value expression representing the end of the string value.
Returns

public static QueryExp geq (ValueExp v1, ValueExp v2)

Returns a query expression that represents a "greater than or equal to" constraint on two values.

Parameters
v1 A value expression.
v2 Another value expression.
Returns
  • A "greater than or equal to" constraint on the arguments. The returned object will be serialized as an instance of the non-public class javax.management.BinaryRelQueryExp with a relOp equal to GE.

public static QueryExp gt (ValueExp v1, ValueExp v2)

Returns a query expression that represents a "greater than" constraint on two values.

Parameters
v1 A value expression.
v2 Another value expression.
Returns
  • A "greater than" constraint on the arguments. The returned object will be serialized as an instance of the non-public class javax.management.BinaryRelQueryExp with a relOp equal to GT.

public static QueryExp in (ValueExp val, ValueExp[] valueList)

Returns an expression constraining a value to be one of an explicit list.

Parameters
val A value to be constrained.
valueList An array of ValueExps.
Returns
  • A QueryExp that represents the constraint. The returned object will be serialized as an instance of the non-public class javax.management.InQueryExp.

public static QueryExp initialSubString (AttributeValueExp a, StringValueExp s)

Returns a query expression that represents a matching constraint on a string argument. The value must start with the given literal string value.

Parameters
a An attribute expression.
s A string value expression representing the beginning of the string value.
Returns

public static QueryExp isInstanceOf (StringValueExp classNameValue)

Returns a query expression that represents an inheritance constraint on an MBean class.

Example: to find MBeans that are instances of NotificationBroadcaster, use Query.isInstanceOf(Query.value(NotificationBroadcaster.class.getName())).

Evaluating this expression for a given objectName includes performing MBeanServer.isInstanceOf(objectName, ((StringValueExp)classNameValue.apply(objectName)).getValue().

Parameters
classNameValue The StringValueExp returning the name of the class of which selected MBeans should be instances.
Returns
  • a query expression that represents an inheritance constraint on an MBean class. The returned object will be serialized as an instance of the non-public class javax.management.InstanceOfQueryExp.

public static QueryExp leq (ValueExp v1, ValueExp v2)

Returns a query expression that represents a "less than or equal to" constraint on two values.

Parameters
v1 A value expression.
v2 Another value expression.
Returns
  • A "less than or equal to" constraint on the arguments. The returned object will be serialized as an instance of the non-public class javax.management.BinaryRelQueryExp with a relOp equal to LE.

public static QueryExp lt (ValueExp v1, ValueExp v2)

Returns a query expression that represents a "less than" constraint on two values.

Parameters
v1 A value expression.
v2 Another value expression.
Returns

public static QueryExp match (AttributeValueExp a, StringValueExp s)

Returns a query expression that represents a matching constraint on a string argument. The matching syntax is consistent with file globbing: supports "?", "*", "[", each of which may be escaped with "\"; character classes may use "!" for negation and "-" for range. (* for any character sequence, ? for a single arbitrary character, [...] for a character sequence). For example: a*b?c would match a string starting with the character a, followed by any number of characters, followed by a b, any single character, and a c.

Parameters
a An attribute expression
s A string value expression representing a matching constraint
Returns
  • A query expression that represents the matching constraint on the string argument. The returned object will be serialized as an instance of the non-public class javax.management.MatchQueryExp.

public static ValueExp minus (ValueExp value1, ValueExp value2)

Returns a binary expression representing the difference between two numeric values.

Parameters
value1 The first '-' operand.
value2 The second '-' operand.
Returns
  • A ValueExp representing the difference between two arguments. The returned object will be serialized as an instance of the non-public class javax.management.BinaryOpValueExp with an op equal to MINUS.

public static QueryExp not (QueryExp queryExp)

Returns a constraint that is the negation of its argument.

Parameters
queryExp The constraint to negate.
Returns

public static QueryExp or (QueryExp q1, QueryExp q2)

Returns a query expression that is the disjunction of two other query expressions.

Parameters
q1 A query expression.
q2 Another query expression.
Returns
  • The disjunction of the two arguments. The returned object will be serialized as an instance of the non-public class javax.management.OrQueryExp.

public static ValueExp plus (ValueExp value1, ValueExp value2)

Returns a binary expression representing the sum of two numeric values, or the concatenation of two string values.

Parameters
value1 The first '+' operand.
value2 The second '+' operand.
Returns
  • A ValueExp representing the sum or concatenation of the two arguments. The returned object will be serialized as an instance of the non-public class javax.management.BinaryOpValueExp with an op equal to PLUS.

public static ValueExp times (ValueExp value1, ValueExp value2)

Returns a binary expression representing the product of two numeric values.

Parameters
value1 The first '*' operand.
value2 The second '*' operand.
Returns

public static ValueExp value (double val)

Returns a numeric value expression that can be used in any Query call that expects a ValueExp.

Parameters
val A double value.
Returns

public static ValueExp value (long val)

Returns a numeric value expression that can be used in any Query call that expects a ValueExp.

Parameters
val A long value.
Returns

public static ValueExp value (boolean val)

Returns a boolean value expression that can be used in any Query call that expects a ValueExp.

Parameters
val A boolean value.
Returns

public static ValueExp value (float val)

Returns a numeric value expression that can be used in any Query call that expects a ValueExp.

Parameters
val A float value.
Returns

public static ValueExp value (int val)

Returns a numeric value expression that can be used in any Query call that expects a ValueExp.

Parameters
val An int value.
Returns

public static ValueExp value (Number val)

Returns a numeric value expression that can be used in any Query call that expects a ValueExp.

Parameters
val An instance of Number.
Returns

public static StringValueExp value (String val)

Returns a new string expression.

Parameters
val The string value.
Returns
  • A ValueExp object containing the string argument.