Please note that this documentation is not final and is subject to change.

javax.management
Class JMX.MBeanOptions

java.lang.Object
  javax.management.JMX.MBeanOptions

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

JMX.ProxyOptions, StandardMBean.Options

Enclosing class:

JMX

public static class JMX.MBeanOptions
extends Object
implements Serializable, Cloneable

Options to apply to an MBean proxy or to an instance of StandardMBean.

For example, to specify a custom MXBeanMappingFactory for a StandardMBean, you might write this:

 MXBeanMappingFactory factory = new MyMXBeanMappingFactory();
 JMX.MBeanOptions opts = new JMX.MBeanOptions();
 opts.setMXBeanMappingFactory(factory);
 StandardMBean mbean = new StandardMBean(impl, intf, opts);
 

See Also:

JMX.ProxyOptions, StandardMBean.Options, Serialized Form

Constructor Summary

JMX.MBeanOptions()
Construct an MBeanOptions object where all options have their default values.

Method Summary

JMX.MBeanOptions	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
MXBeanMappingFactory	getMXBeanMappingFactory() The mappings between Java types and Open Types to be used in an MXBean proxy or a StandardMBean instance that is an MXBean, or null if this instance is not for an MXBean.
int	hashCode() Returns a hash code value for the object.
boolean	isMXBean() True if this is an MXBean proxy or a StandardMBean instance that is an MXBean.
void	setMXBeanMappingFactory(MXBeanMappingFactory f) Set the MXBeanMappingFactory to the given value.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

JMX.MBeanOptions

public JMX.MBeanOptions()

Construct an MBeanOptions object where all options have their default values.

Method Detail

clone

public JMX.MBeanOptions clone()

Description copied from class: Object

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

 x.clone() != x

will be true, and that the expression:

 x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

 x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

The method clone for class Object performs a specific cloning operation. First, if the class of this object does not implement the interface Cloneable, then a CloneNotSupportedException is thrown. Note that all arrays are considered to implement the interface Cloneable. Otherwise, this method creates a new instance of the class of this object and initializes all its fields with exactly the contents of the corresponding fields of this object, as if by assignment; the contents of the fields are not themselves cloned. Thus, this method performs a "shallow copy" of this object, not a "deep copy" operation.

The class Object does not itself implement the interface Cloneable, so calling the clone method on an object whose class is Object will result in throwing an exception at run time.

Overrides:

clone in class Object

Returns:

a clone of this instance.

See Also:

Cloneable

isMXBean

public boolean isMXBean()

True if this is an MXBean proxy or a StandardMBean instance that is an MXBean. The default value is false.

This method is equivalent to this.getMXBeanMappingFactory()!= null.

Returns:

true if this is an MXBean proxy or a StandardMBean instance that is an MXBean.

getMXBeanMappingFactory

public MXBeanMappingFactory getMXBeanMappingFactory()

The mappings between Java types and Open Types to be used in an MXBean proxy or a StandardMBean instance that is an MXBean, or null if this instance is not for an MXBean. The default value is null.

Returns:

the mappings to be used in this proxy or StandardMBean, or null if this instance is not for an MXBean.

setMXBeanMappingFactory

public void setMXBeanMappingFactory(MXBeanMappingFactory f)

Set the MXBeanMappingFactory to the given value. The value should be null if this instance is not for an MXBean. If this instance is for an MXBean, the value should usually be either a custom mapping factory, or MXBeanMappingFactory.forInterface(mxbeanInterface) which signifies that the default mapping factory should be used unless an @MXBeanMappingFactoryClass annotation on mxbeanInterface specifies otherwise.

Examples:

 MBeanOptions opts = new MBeanOptions();
 opts.setMXBeanMappingFactory(myMappingFactory);
 MyMXBean proxy = JMX.newMBeanProxy(
         mbeanServerConnection, objectName, MyMXBean.class, opts);

 // ...or...

 MBeanOptions opts = new MBeanOptions();
 MXBeanMappingFactory defaultFactoryForMyMXBean =
         MXBeanMappingFactory.forInterface(MyMXBean.class);
 opts.setMXBeanMappingFactory(defaultFactoryForMyMXBean);
 MyMXBean proxy = JMX.newMBeanProxy(
         mbeanServerConnection, objectName, MyMXBean.class, opts);
 

Parameters:

f - the new value. If null, this instance is not for an MXBean.

toString

public String toString()

Description copied from class: Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class Object

Returns:

a string representation of the object.

equals

public boolean equals(Object obj)

Indicates whether some other object is "equal to" this one. The result is true if and only if the other object is also an instance of MBeanOptions or a subclass, and has the same properties with the same values.

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Object.hashCode(), Hashtable

hashCode

public int hashCode()

Description copied from class: Object

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), Hashtable