This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.management
class Query

java.lang.Object extended by javax.management.Query

public class Query
extends Object

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")));
 


Field Summary
static int DIV
          A code representing the javax.management.Query.div expression.
static int EQ
          A code representing the javax.management.Query.eq query.
static int GE
          A code representing the javax.management.Query.geq query.
static int GT
          A code representing the javax.management.Query.gt query.
static int LE
          A code representing the javax.management.Query.leq query.
static int LT
          A code representing the javax.management.Query.lt query.
static int MINUS
          A code representing the javax.management.Query.minus expression.
static int PLUS
          A code representing the javax.management.Query.plus expression.
static int TIMES
          A code representing the javax.management.Query.times expression.
 
Constructor Summary

          Basic constructor.
 
Method Summary
static QueryExp

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

          Returns a query expression that represents a matching constraint on a string argument.
static AttributeValueExp
attr(String name)

          Returns a new attribute expression.
static AttributeValueExp
attr(String className, String name)

          Returns a new qualified attribute expression.
static QueryExp

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

          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

          Returns a query expression that represents a matching constraint on a string argument.
static QueryExp

          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

          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

          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

          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(boolean val)

          Returns a boolean value expression that can be used in any Query call that expects a ValueExp.
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(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(long val)

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

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

          Returns a new string expression.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DIV

public static final int DIV
A code representing the {@link Query#div} expression. This is chiefly of interest for the serialized form of queries.

EQ

public static final int EQ
A code representing the {@link Query#eq} query. This is chiefly of interest for the serialized form of queries.

GE

public static final int GE
A code representing the {@link Query#geq} query. This is chiefly of interest for the serialized form of queries.

GT

public static final int GT
A code representing the {@link Query#gt} query. This is chiefly of interest for the serialized form of queries.

LE

public static final int LE
A code representing the {@link Query#leq} query. This is chiefly of interest for the serialized form of queries.

LT

public static final int LT
A code representing the {@link Query#lt} query. This is chiefly of interest for the serialized form of queries.

MINUS

public static final int MINUS
A code representing the {@link Query#minus} expression. This is chiefly of interest for the serialized form of queries.

PLUS

public static final int PLUS
A code representing the {@link Query#plus} expression. This is chiefly of interest for the serialized form of queries.

TIMES

public static final int TIMES
A code representing the {@link Query#times} expression. This is chiefly of interest for the serialized form of queries.
Constructor Detail

Query

public Query()
Basic constructor.

Method Detail

and

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 {@link javax.management.AndQueryExp}.

anySubString

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:
The constraint that a matches s. The returned object will be serialized as an instance of the non-public class {@link javax.management.MatchQueryExp}.

attr

public static AttributeValueExp attr(String name)

Returns a new attribute expression.

Evaluating this expression for a given objectName includes performing {@link MBeanServer#getAttribute MBeanServer.getAttribute(objectName, name)}.

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

attr

public static AttributeValueExp attr(String className,
                                     String name)

Returns a new qualified attribute expression.

Evaluating this expression for a given objectName includes performing {@link MBeanServer#getObjectInstance MBeanServer.getObjectInstance(objectName)} and {@link MBeanServer#getAttribute MBeanServer.getAttribute(objectName, name)}.

Parameters:
className - The name of the class possessing the attribute.
name - The name of the attribute.
Returns:
An attribute expression for the attribute named name. The returned object will be serialized as an instance of the non-public class {@link javax.management.QualifiedAttributeValueExp}.

between

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:
The constraint that v1 lies between v2 and v3. The returned object will be serialized as an instance of the non-public class {@link javax.management.BetweenQueryExp}.

classattr

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 {@link MBeanServer#getObjectInstance MBeanServer.getObjectInstance(objectName)}.

Returns:
A class attribute expression. The returned object will be serialized as an instance of the non-public class {@link javax.management.ClassAttributeValueExp}.

div

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 {@link javax.management.BinaryOpValueExp} with an {@code op} equal to {@link #DIV}.

eq

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:
A "equal to" constraint on the arguments. The returned object will be serialized as an instance of the non-public class {@link javax.management.BinaryRelQueryExp} with a {@code relOp} equal to {@link #EQ}.

finalSubString

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:
The constraint that a matches s. The returned object will be serialized as an instance of the non-public class {@link javax.management.MatchQueryExp}.

geq

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 {@link javax.management.BinaryRelQueryExp} with a {@code relOp} equal to {@link #GE}.

gt

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 {@link javax.management.BinaryRelQueryExp} with a {@code relOp} equal to {@link #GT}.

in

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 {@link javax.management.InQueryExp}.

initialSubString

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:
The constraint that a matches s. The returned object will be serialized as an instance of the non-public class {@link javax.management.MatchQueryExp}.

isInstanceOf

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 {@link NotificationBroadcaster}, use {@code Query.isInstanceOf(Query.value(NotificationBroadcaster.class.getName()))}.

Evaluating this expression for a given objectName includes performing {@link MBeanServer#isInstanceOf MBeanServer.isInstanceOf(objectName, ((StringValueExp)classNameValue.apply(objectName)).getValue()}.

Parameters:
classNameValue - The {@link 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 {@link javax.management.InstanceOfQueryExp}.

leq

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 {@link javax.management.BinaryRelQueryExp} with a {@code relOp} equal to {@link #LE}.

lt

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:
A "less than" constraint on the arguments. The returned object will be serialized as an instance of the non-public class {@link javax.management.BinaryRelQueryExp} with a {@code relOp} equal to {@link #LT}.

match

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 {@link javax.management.MatchQueryExp}.

minus

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 {@link javax.management.BinaryOpValueExp} with an {@code op} equal to {@link #MINUS}.

not

public static QueryExp not(QueryExp queryExp)
Returns a constraint that is the negation of its argument.

Parameters:
queryExp - The constraint to negate.
Returns:
A negated constraint. The returned object will be serialized as an instance of the non-public class {@link javax.management.NotQueryExp}.

or

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 {@link javax.management.OrQueryExp}.

plus

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 {@link javax.management.BinaryOpValueExp} with an {@code op} equal to {@link #PLUS}.

times

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:
A ValueExp representing the product. The returned object will be serialized as an instance of the non-public class {@link javax.management.BinaryOpValueExp} with an {@code op} equal to {@link #TIMES}.

value

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:
A ValueExp object containing the argument. The returned object will be serialized as an instance of the non-public class {@link javax.management.BooleanValueExp}.

value

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:
A ValueExp object containing the argument. The returned object will be serialized as an instance of the non-public class {@link javax.management.NumericValueExp}.

value

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:
A ValueExp object containing the argument. The returned object will be serialized as an instance of the non-public class {@link javax.management.NumericValueExp}.

value

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:
A ValueExp object containing the argument. The returned object will be serialized as an instance of the non-public class {@link javax.management.NumericValueExp}.

value

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:
A ValueExp object containing the argument. The returned object will be serialized as an instance of the non-public class {@link javax.management.NumericValueExp}.

value

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:
A ValueExp object containing the argument. The returned object will be serialized as an instance of the non-public class {@link javax.management.NumericValueExp}.

value

public static StringValueExp value(String val)
Returns a new string expression.

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


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.