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

javax.management
Class StandardMBean.Options

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

All Implemented Interfaces:

Serializable, Cloneable

Enclosing class:

StandardMBean

public static class StandardMBean.Options
extends JMX.MBeanOptions

Options controlling the behavior of StandardMBean instances.

See Also:

Serialized Form

Constructor and Description

StandardMBean.Options()
Construct an Options object where all options have their default values.

Method Summary

Modifier and Type	Method and Description
StandardMBean.Options	clone() Creates and returns a copy of this object.
boolean	isMBeanRegistrationForwarded() Defines whether the MBeanRegistration callbacks are forwarded to the wrapped object.
boolean	isWrappedObjectVisible() Defines whether the getWrappedObject method returns the wrapped object.
void	setMBeanRegistrationForwarded(boolean forward) Set the MBeanRegistrationForwarded option to the given value.
void	setWrappedObjectVisible(boolean visible) Set the WrappedObjectVisible option to the given value.

Methods inherited from class javax.management.JMX.MBeanOptions

equals, getMXBeanMappingFactory, hashCode, isMXBean, setMXBeanMappingFactory, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardMBean.Options

public StandardMBean.Options()

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

Method Detail

clone

public StandardMBean.Options 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 JMX.MBeanOptions

Returns:

a clone of this instance.

See Also:

Cloneable

isWrappedObjectVisible

public boolean isWrappedObjectVisible()

Defines whether the getWrappedObject method returns the wrapped object.

If this option is true, then getWrappedObject() will return the same object as getImplementation. Otherwise, it will return the StandardMBean instance itself. The setting of this option affects the behavior of MBeanServer.getClassLoaderFor and MBeanServer.isInstanceOf. The default value is false for compatibility reasons, but true is a better value for most new code.

Returns:

true if this StandardMBean's getWrappedObject returns the wrapped object.

setWrappedObjectVisible

public void setWrappedObjectVisible(boolean visible)

Set the WrappedObjectVisible option to the given value.

Parameters:

visible - the new value.

isMBeanRegistrationForwarded

public boolean isMBeanRegistrationForwarded()

Defines whether the MBeanRegistration callbacks are forwarded to the wrapped object.

If this option is true, then preRegister, postRegister, preDeregister and postDeregister methods are forwarded to the wrapped object, in addition to the behaviour specified for the StandardMBean instance itself. The default value is false for compatibility reasons, but true is a better value for most new code.

Returns:

true if the MBeanRegistration callbacks are forwarded to the wrapped object.

setMBeanRegistrationForwarded

public void setMBeanRegistrationForwarded(boolean forward)

Set the MBeanRegistrationForwarded option to the given value.

Parameters:

forward - the new value.