Class MBeanOperationInfo

    • Field Detail

      • INFO

        public static final int INFO
        Indicates that the operation is read-like: it returns information but does not change any state.
        See Also:
        Constant Field Values
      • ACTION

        public static final int ACTION
        Indicates that the operation is write-like: it has an effect but does not return any information from the MBean.
        See Also:
        Constant Field Values
      • ACTION_INFO

        public static final int ACTION_INFO
        Indicates that the operation is both read-like and write-like: it has an effect, and it also returns information from the MBean.
        See Also:
        Constant Field Values
      • UNKNOWN

        public static final int UNKNOWN
        Indicates that the impact of the operation is unknown or cannot be expressed using one of the other values.
        See Also:
        Constant Field Values
    • Constructor Detail

      • MBeanOperationInfo

        public MBeanOperationInfo​(String description,
                                  Method method)
        Constructs an MBeanOperationInfo object. The Descriptor of the constructed object will include fields contributed by any annotations on the Method object that contain the DescriptorKey meta-annotation.
        Parameters:
        method - The java.lang.reflect.Method object describing the MBean operation.
        description - A human readable description of the operation.
      • MBeanOperationInfo

        public MBeanOperationInfo​(String name,
                                  String description,
                                  MBeanParameterInfo[] signature,
                                  String type,
                                  int impact)
        Constructs an MBeanOperationInfo object.
        Parameters:
        name - The name of the method.
        description - A human readable description of the operation.
        signature - MBeanParameterInfo objects describing the parameters(arguments) of the method. This may be null with the same effect as a zero-length array.
        type - The type of the method's return value.
        impact - The impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.
      • MBeanOperationInfo

        public MBeanOperationInfo​(String name,
                                  String description,
                                  MBeanParameterInfo[] signature,
                                  String type,
                                  int impact,
                                  Descriptor descriptor)
        Constructs an MBeanOperationInfo object.
        Parameters:
        name - The name of the method.
        description - A human readable description of the operation.
        signature - MBeanParameterInfo objects describing the parameters(arguments) of the method. This may be null with the same effect as a zero-length array.
        type - The type of the method's return value.
        impact - The impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.
        descriptor - The descriptor for the operation. This may be null which is equivalent to an empty descriptor.
        Throws:
        IllegalArgumentException - if impact is not one of ACTION, ACTION_INFO, INFO or UNKNOWN.
        Since:
        1.6
    • Method Detail

      • clone

        public Object clone()

        Returns a shallow clone of this instance. The clone is obtained by simply calling super.clone(), thus calling the default native shallow cloning mechanism implemented by Object.clone(). No deeper cloning of any internal field is made.

        Since this class is immutable, cloning is chiefly of interest to subclasses.

        Overrides:
        clone in class Object
        Returns:
        a clone of this instance.
        See Also:
        Cloneable
      • getReturnType

        public String getReturnType()
        Returns the type of the method's return value.
        Returns:
        the return type.
      • getSignature

        public MBeanParameterInfo[] getSignature()

        Returns the list of parameters for this operation. Each parameter is described by an MBeanParameterInfo object.

        The returned array is a shallow copy of the internal array, which means that it is a copy of the internal array of references to the MBeanParameterInfo objects but that each referenced MBeanParameterInfo object is not copied.

        Returns:
        An array of MBeanParameterInfo objects.
      • getImpact

        public int getImpact()
        Returns the impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.
        Returns:
        the impact code.