8133040: docs: replace <tt> tags (obsolete in html5) for java.management
Reviewed-by: dfuchs
This commit is contained in:
parent
321faa7346
commit
7d145a9a12
jdk/src/java.management/share/classes
com/sun/jmx
java/lang/management
ClassLoadingMXBean.javaCompilationMXBean.javaGarbageCollectorMXBean.javaLockInfo.javaManagementFactory.javaMemoryMXBean.javaMemoryManagerMXBean.javaMemoryNotificationInfo.javaMemoryPoolMXBean.javaMemoryType.javaMemoryUsage.javaMonitorInfo.javaOperatingSystemMXBean.javaPlatformLoggingMXBean.javaRuntimeMXBean.javaThreadMXBean.javapackage.html
javax/management
MBeanAttributeInfo.javaMBeanConstructorInfo.javaMBeanInfo.javaMBeanNotificationInfo.javaMBeanOperationInfo.javaMBeanParameterInfo.java
monitor
openmbean
ArrayType.javaCompositeData.javaCompositeDataSupport.javaOpenMBeanAttributeInfo.javaOpenMBeanAttributeInfoSupport.javaOpenMBeanConstructorInfo.javaOpenMBeanInfo.javaOpenMBeanOperationInfo.javaOpenMBeanParameterInfo.javaTabularData.javaTabularDataSupport.java
relation
remote/rmi
@ -28,7 +28,7 @@ package com.sun.jmx.mbeanserver;
|
||||
import java.security.PrivilegedAction;
|
||||
|
||||
/**
|
||||
* Utility class to be used by the method <tt>AccessControler.doPrivileged</tt>
|
||||
* Utility class to be used by the method {@code AccessControler.doPrivileged}
|
||||
* to get a system property.
|
||||
*
|
||||
* @since 1.5
|
||||
|
@ -177,7 +177,7 @@ public class EnvHelp {
|
||||
* The ClassLoader object found in <var>env</var> for
|
||||
* <code>jmx.remote.default.class.loader</code>, if any.
|
||||
* </li>
|
||||
* <li>The <tt>Thread.currentThread().getContextClassLoader()</tt>
|
||||
* <li>The {@code Thread.currentThread().getContextClassLoader()}
|
||||
* otherwise.
|
||||
* </li>
|
||||
* </ul>
|
||||
|
@ -35,13 +35,13 @@ package java.lang.management;
|
||||
* that can be obtained by calling
|
||||
* the {@link ManagementFactory#getClassLoadingMXBean} method or
|
||||
* from the {@link ManagementFactory#getPlatformMBeanServer
|
||||
* platform <tt>MBeanServer</tt>}.
|
||||
* platform MBeanServer}.
|
||||
*
|
||||
* <p>The <tt>ObjectName</tt> for uniquely identifying the MXBean for
|
||||
* the class loading system within an <tt>MBeanServer</tt> is:
|
||||
* <p>The {@code ObjectName} for uniquely identifying the MXBean for
|
||||
* the class loading system within an {@code MBeanServer} is:
|
||||
* <blockquote>
|
||||
* {@link ManagementFactory#CLASS_LOADING_MXBEAN_NAME
|
||||
* <tt>java.lang:type=ClassLoading</tt>}
|
||||
* java.lang:type=ClassLoading}
|
||||
* </blockquote>
|
||||
*
|
||||
* It can be obtained by calling the
|
||||
@ -86,8 +86,8 @@ public interface ClassLoadingMXBean extends PlatformManagedObject {
|
||||
/**
|
||||
* Tests if the verbose output for the class loading system is enabled.
|
||||
*
|
||||
* @return <tt>true</tt> if the verbose output for the class loading
|
||||
* system is enabled; <tt>false</tt> otherwise.
|
||||
* @return {@code true} if the verbose output for the class loading
|
||||
* system is enabled; {@code false} otherwise.
|
||||
*/
|
||||
public boolean isVerbose();
|
||||
|
||||
@ -102,8 +102,8 @@ public interface ClassLoadingMXBean extends PlatformManagedObject {
|
||||
* Each invocation of this method enables or disables the verbose
|
||||
* output globally.
|
||||
*
|
||||
* @param value <tt>true</tt> to enable the verbose output;
|
||||
* <tt>false</tt> to disable.
|
||||
* @param value {@code true} to enable the verbose output;
|
||||
* {@code false} to disable.
|
||||
*
|
||||
* @exception java.lang.SecurityException if a security manager
|
||||
* exists and the caller does not have
|
||||
|
@ -35,13 +35,13 @@ package java.lang.management;
|
||||
* that can be obtained by calling
|
||||
* the {@link ManagementFactory#getCompilationMXBean} method or
|
||||
* from the {@link ManagementFactory#getPlatformMBeanServer
|
||||
* platform <tt>MBeanServer</tt>} method.
|
||||
* platform MBeanServer} method.
|
||||
*
|
||||
* <p>The <tt>ObjectName</tt> for uniquely identifying the MXBean for
|
||||
* <p>The {@code ObjectName} for uniquely identifying the MXBean for
|
||||
* the compilation system within an MBeanServer is:
|
||||
* <blockquote>
|
||||
* {@link ManagementFactory#COMPILATION_MXBEAN_NAME
|
||||
* <tt>java.lang:type=Compilation</tt>}
|
||||
* java.lang:type=Compilation}
|
||||
* </blockquote>
|
||||
*
|
||||
* It can be obtained by calling the
|
||||
@ -68,8 +68,8 @@ public interface CompilationMXBean extends PlatformManagedObject {
|
||||
* Tests if the Java virtual machine supports the monitoring of
|
||||
* compilation time.
|
||||
*
|
||||
* @return <tt>true</tt> if the monitoring of compilation time is
|
||||
* supported ; <tt>false</tt> otherwise.
|
||||
* @return {@code true} if the monitoring of compilation time is
|
||||
* supported; {@code false} otherwise.
|
||||
*/
|
||||
public boolean isCompilationTimeMonitoringSupported();
|
||||
|
||||
|
@ -39,13 +39,13 @@ package java.lang.management;
|
||||
* that can be obtained by calling
|
||||
* the {@link ManagementFactory#getGarbageCollectorMXBeans} method or
|
||||
* from the {@link ManagementFactory#getPlatformMBeanServer
|
||||
* platform <tt>MBeanServer</tt>} method.
|
||||
* platform MBeanServer} method.
|
||||
*
|
||||
* <p>The <tt>ObjectName</tt> for uniquely identifying the MXBean for
|
||||
* <p>The {@code ObjectName} for uniquely identifying the MXBean for
|
||||
* a garbage collector within an MBeanServer is:
|
||||
* <blockquote>
|
||||
* {@link ManagementFactory#GARBAGE_COLLECTOR_MXBEAN_DOMAIN_TYPE
|
||||
* <tt>java.lang:type=GarbageCollector</tt>}<tt>,name=</tt><i>collector's name</i>
|
||||
* java.lang:type=GarbageCollector}{@code ,name=}<i>collector's name</i>
|
||||
* </blockquote>
|
||||
*
|
||||
* It can be obtained by calling the
|
||||
@ -68,7 +68,7 @@ package java.lang.management;
|
||||
public interface GarbageCollectorMXBean extends MemoryManagerMXBean {
|
||||
/**
|
||||
* Returns the total number of collections that have occurred.
|
||||
* This method returns <tt>-1</tt> if the collection count is undefined for
|
||||
* This method returns {@code -1} if the collection count is undefined for
|
||||
* this collector.
|
||||
*
|
||||
* @return the total number of collections that have occurred.
|
||||
@ -77,7 +77,7 @@ public interface GarbageCollectorMXBean extends MemoryManagerMXBean {
|
||||
|
||||
/**
|
||||
* Returns the approximate accumulated collection elapsed time
|
||||
* in milliseconds. This method returns <tt>-1</tt> if the collection
|
||||
* in milliseconds. This method returns {@code -1} if the collection
|
||||
* elapsed time is undefined for this collector.
|
||||
* <p>
|
||||
* The Java virtual machine implementation may use a high resolution
|
||||
|
@ -43,7 +43,7 @@ import sun.management.LockInfoCompositeData;
|
||||
* two examples of ownable synchronizers provided by the platform.
|
||||
*
|
||||
* <h3><a name="MappedType">MXBean Mapping</a></h3>
|
||||
* <tt>LockInfo</tt> is mapped to a {@link CompositeData CompositeData}
|
||||
* {@code LockInfo} is mapped to a {@link CompositeData CompositeData}
|
||||
* as specified in the {@link #from from} method.
|
||||
*
|
||||
* @see java.util.concurrent.locks.AbstractOwnableSynchronizer
|
||||
@ -59,7 +59,7 @@ public class LockInfo {
|
||||
private int identityHashCode;
|
||||
|
||||
/**
|
||||
* Constructs a <tt>LockInfo</tt> object.
|
||||
* Constructs a {@code LockInfo} object.
|
||||
*
|
||||
* @param className the fully qualified name of the class of the lock object.
|
||||
* @param identityHashCode the {@link System#identityHashCode
|
||||
@ -112,11 +112,11 @@ public class LockInfo {
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td>className</td>
|
||||
* <td><tt>java.lang.String</tt></td>
|
||||
* <td>{@code java.lang.String}</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td>identityHashCode</td>
|
||||
* <td><tt>java.lang.Integer</tt></td>
|
||||
* <td>{@code java.lang.Integer}</td>
|
||||
* </tr>
|
||||
* </table>
|
||||
* </blockquote>
|
||||
@ -154,7 +154,7 @@ public class LockInfo {
|
||||
* <pre>
|
||||
* lock.getClass().getName() + '@' + Integer.toHexString(System.identityHashCode(lock))
|
||||
* </pre></blockquote>
|
||||
* where <tt>lock</tt> is the lock object.
|
||||
* where {@code lock} is the lock object.
|
||||
*
|
||||
* @return the string representation of a lock.
|
||||
*/
|
||||
|
@ -116,7 +116,7 @@ import sun.management.spi.PlatformMBeanProvider.PlatformComponent;
|
||||
* <h4>2. Indirect access to an MXBean interface via MBeanServer</h4>
|
||||
* <ul>
|
||||
* <li>Go through the platform {@code MBeanServer} to access MXBeans
|
||||
* locally or a specific <tt>MBeanServerConnection</tt> to access
|
||||
* locally or a specific {@code MBeanServerConnection} to access
|
||||
* MXBeans remotely.
|
||||
* The attributes and operations of an MXBean use only
|
||||
* <em>JMX open types</em> which include basic data types,
|
||||
@ -209,17 +209,17 @@ import sun.management.spi.PlatformMBeanProvider.PlatformComponent;
|
||||
* <tr>
|
||||
* <td> {@link GarbageCollectorMXBean} </td>
|
||||
* <td> {@link #GARBAGE_COLLECTOR_MXBEAN_DOMAIN_TYPE
|
||||
* java.lang:type=GarbageCollector}<tt>,name=</tt><i>collector's name</i></td>
|
||||
* java.lang:type=GarbageCollector}{@code ,name=}<i>collector's name</i></td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td> {@link MemoryManagerMXBean} </td>
|
||||
* <td> {@link #MEMORY_MANAGER_MXBEAN_DOMAIN_TYPE
|
||||
* java.lang:type=MemoryManager}<tt>,name=</tt><i>manager's name</i></td>
|
||||
* java.lang:type=MemoryManager}{@code ,name=}<i>manager's name</i></td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td> {@link MemoryPoolMXBean} </td>
|
||||
* <td> {@link #MEMORY_POOL_MXBEAN_DOMAIN_TYPE
|
||||
* java.lang:type=MemoryPool}<tt>,name=</tt><i>pool's name</i></td>
|
||||
* java.lang:type=MemoryPool}{@code ,name=}<i>pool's name</i></td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td> {@link BufferPoolMXBean} </td>
|
||||
@ -243,72 +243,72 @@ public class ManagementFactory {
|
||||
|
||||
/**
|
||||
* String representation of the
|
||||
* <tt>ObjectName</tt> for the {@link ClassLoadingMXBean}.
|
||||
* {@code ObjectName} for the {@link ClassLoadingMXBean}.
|
||||
*/
|
||||
public final static String CLASS_LOADING_MXBEAN_NAME =
|
||||
"java.lang:type=ClassLoading";
|
||||
|
||||
/**
|
||||
* String representation of the
|
||||
* <tt>ObjectName</tt> for the {@link CompilationMXBean}.
|
||||
* {@code ObjectName} for the {@link CompilationMXBean}.
|
||||
*/
|
||||
public final static String COMPILATION_MXBEAN_NAME =
|
||||
"java.lang:type=Compilation";
|
||||
|
||||
/**
|
||||
* String representation of the
|
||||
* <tt>ObjectName</tt> for the {@link MemoryMXBean}.
|
||||
* {@code ObjectName} for the {@link MemoryMXBean}.
|
||||
*/
|
||||
public final static String MEMORY_MXBEAN_NAME =
|
||||
"java.lang:type=Memory";
|
||||
|
||||
/**
|
||||
* String representation of the
|
||||
* <tt>ObjectName</tt> for the {@link OperatingSystemMXBean}.
|
||||
* {@code ObjectName} for the {@link OperatingSystemMXBean}.
|
||||
*/
|
||||
public final static String OPERATING_SYSTEM_MXBEAN_NAME =
|
||||
"java.lang:type=OperatingSystem";
|
||||
|
||||
/**
|
||||
* String representation of the
|
||||
* <tt>ObjectName</tt> for the {@link RuntimeMXBean}.
|
||||
* {@code ObjectName} for the {@link RuntimeMXBean}.
|
||||
*/
|
||||
public final static String RUNTIME_MXBEAN_NAME =
|
||||
"java.lang:type=Runtime";
|
||||
|
||||
/**
|
||||
* String representation of the
|
||||
* <tt>ObjectName</tt> for the {@link ThreadMXBean}.
|
||||
* {@code ObjectName} for the {@link ThreadMXBean}.
|
||||
*/
|
||||
public final static String THREAD_MXBEAN_NAME =
|
||||
"java.lang:type=Threading";
|
||||
|
||||
/**
|
||||
* The domain name and the type key property in
|
||||
* the <tt>ObjectName</tt> for a {@link GarbageCollectorMXBean}.
|
||||
* The unique <tt>ObjectName</tt> for a <tt>GarbageCollectorMXBean</tt>
|
||||
* the {@code ObjectName} for a {@link GarbageCollectorMXBean}.
|
||||
* The unique {@code ObjectName} for a {@code GarbageCollectorMXBean}
|
||||
* can be formed by appending this string with
|
||||
* "<tt>,name=</tt><i>collector's name</i>".
|
||||
* "{@code ,name=}<i>collector's name</i>".
|
||||
*/
|
||||
public final static String GARBAGE_COLLECTOR_MXBEAN_DOMAIN_TYPE =
|
||||
"java.lang:type=GarbageCollector";
|
||||
|
||||
/**
|
||||
* The domain name and the type key property in
|
||||
* the <tt>ObjectName</tt> for a {@link MemoryManagerMXBean}.
|
||||
* The unique <tt>ObjectName</tt> for a <tt>MemoryManagerMXBean</tt>
|
||||
* the {@code ObjectName} for a {@link MemoryManagerMXBean}.
|
||||
* The unique {@code ObjectName} for a {@code MemoryManagerMXBean}
|
||||
* can be formed by appending this string with
|
||||
* "<tt>,name=</tt><i>manager's name</i>".
|
||||
* "{@code ,name=}<i>manager's name</i>".
|
||||
*/
|
||||
public final static String MEMORY_MANAGER_MXBEAN_DOMAIN_TYPE=
|
||||
"java.lang:type=MemoryManager";
|
||||
|
||||
/**
|
||||
* The domain name and the type key property in
|
||||
* the <tt>ObjectName</tt> for a {@link MemoryPoolMXBean}.
|
||||
* The unique <tt>ObjectName</tt> for a <tt>MemoryPoolMXBean</tt>
|
||||
* the {@code ObjectName} for a {@link MemoryPoolMXBean}.
|
||||
* The unique {@code ObjectName} for a {@code MemoryPoolMXBean}
|
||||
* can be formed by appending this string with
|
||||
* <tt>,name=</tt><i>pool's name</i>.
|
||||
* {@code ,name=}<i>pool's name</i>.
|
||||
*/
|
||||
public final static String MEMORY_POOL_MXBEAN_DOMAIN_TYPE=
|
||||
"java.lang:type=MemoryPool";
|
||||
@ -357,11 +357,11 @@ public class ManagementFactory {
|
||||
|
||||
/**
|
||||
* Returns the managed bean for the compilation system of
|
||||
* the Java virtual machine. This method returns <tt>null</tt>
|
||||
* the Java virtual machine. This method returns {@code null}
|
||||
* if the Java virtual machine has no compilation system.
|
||||
*
|
||||
* @return a {@link CompilationMXBean} object for the Java virtual
|
||||
* machine or <tt>null</tt> if the Java virtual machine has
|
||||
* machine or {@code null} if the Java virtual machine has
|
||||
* no compilation system.
|
||||
*/
|
||||
public static CompilationMXBean getCompilationMXBean() {
|
||||
@ -385,7 +385,7 @@ public class ManagementFactory {
|
||||
* The Java virtual machine can have one or more memory pools.
|
||||
* It may add or remove memory pools during execution.
|
||||
*
|
||||
* @return a list of <tt>MemoryPoolMXBean</tt> objects.
|
||||
* @return a list of {@code MemoryPoolMXBean} objects.
|
||||
*
|
||||
*/
|
||||
public static List<MemoryPoolMXBean> getMemoryPoolMXBeans() {
|
||||
@ -398,7 +398,7 @@ public class ManagementFactory {
|
||||
* The Java virtual machine can have one or more memory managers.
|
||||
* It may add or remove memory managers during execution.
|
||||
*
|
||||
* @return a list of <tt>MemoryManagerMXBean</tt> objects.
|
||||
* @return a list of {@code MemoryManagerMXBean} objects.
|
||||
*
|
||||
*/
|
||||
public static List<MemoryManagerMXBean> getMemoryManagerMXBeans() {
|
||||
@ -410,11 +410,11 @@ public class ManagementFactory {
|
||||
* Returns a list of {@link GarbageCollectorMXBean} objects
|
||||
* in the Java virtual machine.
|
||||
* The Java virtual machine may have one or more
|
||||
* <tt>GarbageCollectorMXBean</tt> objects.
|
||||
* It may add or remove <tt>GarbageCollectorMXBean</tt>
|
||||
* {@code GarbageCollectorMXBean} objects.
|
||||
* It may add or remove {@code GarbageCollectorMXBean}
|
||||
* during execution.
|
||||
*
|
||||
* @return a list of <tt>GarbageCollectorMXBean</tt> objects.
|
||||
* @return a list of {@code GarbageCollectorMXBean} objects.
|
||||
*
|
||||
*/
|
||||
public static List<GarbageCollectorMXBean> getGarbageCollectorMXBeans() {
|
||||
@ -485,21 +485,21 @@ public class ManagementFactory {
|
||||
* Returns a proxy for a platform MXBean interface of a
|
||||
* given <a href="#MXBeanNames">MXBean name</a>
|
||||
* that forwards its method calls through the given
|
||||
* <tt>MBeanServerConnection</tt>.
|
||||
* {@code MBeanServerConnection}.
|
||||
*
|
||||
* <p>This method is equivalent to:
|
||||
* <blockquote>
|
||||
* {@link java.lang.reflect.Proxy#newProxyInstance
|
||||
* Proxy.newProxyInstance}<tt>(mxbeanInterface.getClassLoader(),
|
||||
* new Class[] { mxbeanInterface }, handler)</tt>
|
||||
* Proxy.newProxyInstance}{@code (mxbeanInterface.getClassLoader(),
|
||||
* new Class[] { mxbeanInterface }, handler)}
|
||||
* </blockquote>
|
||||
*
|
||||
* where <tt>handler</tt> is an {@link java.lang.reflect.InvocationHandler
|
||||
* where {@code handler} is an {@link java.lang.reflect.InvocationHandler
|
||||
* InvocationHandler} to which method invocations to the MXBean interface
|
||||
* are dispatched. This <tt>handler</tt> converts an input parameter
|
||||
* are dispatched. This {@code handler} converts an input parameter
|
||||
* from an MXBean data type to its mapped open type before forwarding
|
||||
* to the <tt>MBeanServer</tt> and converts a return value from
|
||||
* an MXBean method call through the <tt>MBeanServer</tt>
|
||||
* to the {@code MBeanServer} and converts a return value from
|
||||
* an MXBean method call through the {@code MBeanServer}
|
||||
* from an open type to the corresponding return type declared in
|
||||
* the MXBean interface.
|
||||
*
|
||||
@ -507,7 +507,7 @@ public class ManagementFactory {
|
||||
* If the MXBean is a notification emitter (i.e.,
|
||||
* it implements
|
||||
* {@link javax.management.NotificationEmitter NotificationEmitter}),
|
||||
* both the <tt>mxbeanInterface</tt> and <tt>NotificationEmitter</tt>
|
||||
* both the {@code mxbeanInterface} and {@code NotificationEmitter}
|
||||
* will be implemented by this proxy.
|
||||
*
|
||||
* <p>
|
||||
@ -516,12 +516,12 @@ public class ManagementFactory {
|
||||
* <li>Using an MXBean proxy is a convenience remote access to
|
||||
* a platform MXBean of a running virtual machine. All method
|
||||
* calls to the MXBean proxy are forwarded to an
|
||||
* <tt>MBeanServerConnection</tt> where
|
||||
* {@code MBeanServerConnection} where
|
||||
* {@link java.io.IOException IOException} may be thrown
|
||||
* when the communication problem occurs with the connector server.
|
||||
* An application remotely accesses the platform MXBeans using
|
||||
* proxy should prepare to catch <tt>IOException</tt> as if
|
||||
* accessing with the <tt>MBeanServerConnector</tt> interface.</li>
|
||||
* proxy should prepare to catch {@code IOException} as if
|
||||
* accessing with the {@code MBeanServerConnector} interface.</li>
|
||||
*
|
||||
* <li>When a client application is designed to remotely access MXBeans
|
||||
* for a running virtual machine whose version is different than
|
||||
@ -537,15 +537,15 @@ public class ManagementFactory {
|
||||
* {@link javax.management.MBeanServerInvocationHandler#newProxyInstance
|
||||
* newProxyInstance} method cannot be used to create
|
||||
* a proxy for a platform MXBean. The proxy object created
|
||||
* by <tt>MBeanServerInvocationHandler</tt> does not handle
|
||||
* by {@code MBeanServerInvocationHandler} does not handle
|
||||
* the properties of the platform MXBeans described in
|
||||
* the <a href="#MXBean">class specification</a>.
|
||||
*</li>
|
||||
* </ol>
|
||||
*
|
||||
* @param connection the <tt>MBeanServerConnection</tt> to forward to.
|
||||
* @param connection the {@code MBeanServerConnection} to forward to.
|
||||
* @param mxbeanName the name of a platform MXBean within
|
||||
* <tt>connection</tt> to forward to. <tt>mxbeanName</tt> must be
|
||||
* {@code connection} to forward to. {@code mxbeanName} must be
|
||||
* in the format of {@link ObjectName ObjectName}.
|
||||
* @param mxbeanInterface the MXBean interface to be implemented
|
||||
* by the proxy.
|
||||
@ -554,22 +554,22 @@ public class ManagementFactory {
|
||||
* @return a proxy for a platform MXBean interface of a
|
||||
* given <a href="#MXBeanNames">MXBean name</a>
|
||||
* that forwards its method calls through the given
|
||||
* <tt>MBeanServerConnection</tt>, or {@code null} if not exist.
|
||||
* {@code MBeanServerConnection}, or {@code null} if not exist.
|
||||
*
|
||||
* @throws IllegalArgumentException if
|
||||
* <ul>
|
||||
* <li><tt>mxbeanName</tt> is not with a valid
|
||||
* <li>{@code mxbeanName} is not with a valid
|
||||
* {@link ObjectName ObjectName} format, or</li>
|
||||
* <li>the named MXBean in the <tt>connection</tt> is
|
||||
* <li>the named MXBean in the {@code connection} is
|
||||
* not a MXBean provided by the platform, or</li>
|
||||
* <li>the named MXBean is not registered in the
|
||||
* <tt>MBeanServerConnection</tt>, or</li>
|
||||
* {@code MBeanServerConnection}, or</li>
|
||||
* <li>the named MXBean is not an instance of the given
|
||||
* <tt>mxbeanInterface</tt></li>
|
||||
* {@code mxbeanInterface}</li>
|
||||
* </ul>
|
||||
*
|
||||
* @throws java.io.IOException if a communication problem
|
||||
* occurred when accessing the <tt>MBeanServerConnection</tt>.
|
||||
* occurred when accessing the {@code MBeanServerConnection}.
|
||||
*/
|
||||
public static <T> T
|
||||
newPlatformMXBeanProxy(MBeanServerConnection connection,
|
||||
|
@ -37,13 +37,13 @@ import javax.management.openmbean.CompositeData;
|
||||
* that can be obtained by calling
|
||||
* the {@link ManagementFactory#getMemoryMXBean} method or
|
||||
* from the {@link ManagementFactory#getPlatformMBeanServer
|
||||
* platform <tt>MBeanServer</tt>} method.
|
||||
* platform MBeanServer} method.
|
||||
*
|
||||
* <p>The <tt>ObjectName</tt> for uniquely identifying the MXBean for
|
||||
* <p>The {@code ObjectName} for uniquely identifying the MXBean for
|
||||
* the memory system within an MBeanServer is:
|
||||
* <blockquote>
|
||||
* {@link ManagementFactory#MEMORY_MXBEAN_NAME
|
||||
* <tt>java.lang:type=Memory</tt>}
|
||||
* java.lang:type=Memory}
|
||||
* </blockquote>
|
||||
*
|
||||
* It can be obtained by calling the
|
||||
@ -133,7 +133,7 @@ import javax.management.openmbean.CompositeData;
|
||||
*
|
||||
* <h3>Notifications</h3>
|
||||
*
|
||||
* <p>This <tt>MemoryMXBean</tt> is a
|
||||
* <p>This {@code MemoryMXBean} is a
|
||||
* {@link javax.management.NotificationEmitter NotificationEmitter}
|
||||
* that emits two types of memory {@link javax.management.Notification
|
||||
* notifications} if any one of the memory pools
|
||||
@ -164,20 +164,20 @@ import javax.management.openmbean.CompositeData;
|
||||
* user data} is set to a {@link CompositeData CompositeData}
|
||||
* that represents a {@link MemoryNotificationInfo} object
|
||||
* containing information about the memory pool when the notification
|
||||
* was constructed. The <tt>CompositeData</tt> contains the attributes
|
||||
* was constructed. The {@code CompositeData} contains the attributes
|
||||
* as described in {@link MemoryNotificationInfo#from
|
||||
* MemoryNotificationInfo}.
|
||||
*
|
||||
* <hr>
|
||||
* <h3>NotificationEmitter</h3>
|
||||
* The <tt>MemoryMXBean</tt> object returned by
|
||||
* The {@code MemoryMXBean} object returned by
|
||||
* {@link ManagementFactory#getMemoryMXBean} implements
|
||||
* the {@link javax.management.NotificationEmitter NotificationEmitter}
|
||||
* interface that allows a listener to be registered within the
|
||||
* <tt>MemoryMXBean</tt> as a notification listener.
|
||||
* {@code MemoryMXBean} as a notification listener.
|
||||
*
|
||||
* Below is an example code that registers a <tt>MyListener</tt> to handle
|
||||
* notification emitted by the <tt>MemoryMXBean</tt>.
|
||||
* Below is an example code that registers a {@code MyListener} to handle
|
||||
* notification emitted by the {@code MemoryMXBean}.
|
||||
*
|
||||
* <blockquote><pre>
|
||||
* class MyListener implements javax.management.NotificationListener {
|
||||
@ -215,10 +215,10 @@ public interface MemoryMXBean extends PlatformManagedObject {
|
||||
/**
|
||||
* Returns the current memory usage of the heap that
|
||||
* is used for object allocation. The heap consists
|
||||
* of one or more memory pools. The <tt>used</tt>
|
||||
* and <tt>committed</tt> size of the returned memory
|
||||
* of one or more memory pools. The {@code used}
|
||||
* and {@code committed} size of the returned memory
|
||||
* usage is the sum of those values of all heap memory pools
|
||||
* whereas the <tt>init</tt> and <tt>max</tt> size of the
|
||||
* whereas the {@code init} and {@code max} size of the
|
||||
* returned memory usage represents the setting of the heap
|
||||
* memory which may not be the sum of those of all heap
|
||||
* memory pools.
|
||||
@ -229,8 +229,8 @@ public interface MemoryMXBean extends PlatformManagedObject {
|
||||
*
|
||||
* <p>
|
||||
* <b>MBeanServer access</b>:<br>
|
||||
* The mapped type of <tt>MemoryUsage</tt> is
|
||||
* <tt>CompositeData</tt> with attributes as specified in
|
||||
* The mapped type of {@code MemoryUsage} is
|
||||
* {@code CompositeData} with attributes as specified in
|
||||
* {@link MemoryUsage#from MemoryUsage}.
|
||||
*
|
||||
* @return a {@link MemoryUsage} object representing
|
||||
@ -242,18 +242,18 @@ public interface MemoryMXBean extends PlatformManagedObject {
|
||||
* Returns the current memory usage of non-heap memory that
|
||||
* is used by the Java virtual machine.
|
||||
* The non-heap memory consists of one or more memory pools.
|
||||
* The <tt>used</tt> and <tt>committed</tt> size of the
|
||||
* The {@code used} and {@code committed} size of the
|
||||
* returned memory usage is the sum of those values of
|
||||
* all non-heap memory pools whereas the <tt>init</tt>
|
||||
* and <tt>max</tt> size of the returned memory usage
|
||||
* all non-heap memory pools whereas the {@code init}
|
||||
* and {@code max} size of the returned memory usage
|
||||
* represents the setting of the non-heap
|
||||
* memory which may not be the sum of those of all non-heap
|
||||
* memory pools.
|
||||
*
|
||||
* <p>
|
||||
* <b>MBeanServer access</b>:<br>
|
||||
* The mapped type of <tt>MemoryUsage</tt> is
|
||||
* <tt>CompositeData</tt> with attributes as specified in
|
||||
* The mapped type of {@code MemoryUsage} is
|
||||
* {@code CompositeData} with attributes as specified in
|
||||
* {@link MemoryUsage#from MemoryUsage}.
|
||||
*
|
||||
* @return a {@link MemoryUsage} object representing
|
||||
@ -264,8 +264,8 @@ public interface MemoryMXBean extends PlatformManagedObject {
|
||||
/**
|
||||
* Tests if verbose output for the memory system is enabled.
|
||||
*
|
||||
* @return <tt>true</tt> if verbose output for the memory
|
||||
* system is enabled; <tt>false</tt> otherwise.
|
||||
* @return {@code true} if verbose output for the memory
|
||||
* system is enabled; {@code false} otherwise.
|
||||
*/
|
||||
public boolean isVerbose();
|
||||
|
||||
@ -280,8 +280,8 @@ public interface MemoryMXBean extends PlatformManagedObject {
|
||||
* Each invocation of this method enables or disables verbose
|
||||
* output globally.
|
||||
*
|
||||
* @param value <tt>true</tt> to enable verbose output;
|
||||
* <tt>false</tt> to disable.
|
||||
* @param value {@code true} to enable verbose output;
|
||||
* {@code false} to disable.
|
||||
*
|
||||
* @exception java.lang.SecurityException if a security manager
|
||||
* exists and the caller does not have
|
||||
|
@ -36,13 +36,13 @@ package java.lang.management;
|
||||
* that can be obtained by calling
|
||||
* the {@link ManagementFactory#getMemoryManagerMXBeans} method or
|
||||
* from the {@link ManagementFactory#getPlatformMBeanServer
|
||||
* platform <tt>MBeanServer</tt>} method.
|
||||
* platform MBeanServer} method.
|
||||
*
|
||||
* <p>The <tt>ObjectName</tt> for uniquely identifying the MXBean for
|
||||
* <p>The {@code ObjectName} for uniquely identifying the MXBean for
|
||||
* a memory manager within an MBeanServer is:
|
||||
* <blockquote>
|
||||
* {@link ManagementFactory#MEMORY_MANAGER_MXBEAN_DOMAIN_TYPE
|
||||
* <tt>java.lang:type=MemoryManager</tt>}<tt>,name=</tt><i>manager's name</i>
|
||||
* java.lang:type=MemoryManager}{@code ,name=}<i>manager's name</i>
|
||||
* </blockquote>
|
||||
*
|
||||
* It can be obtained by calling the
|
||||
@ -72,16 +72,16 @@ public interface MemoryManagerMXBean extends PlatformManagedObject {
|
||||
* machine. A memory manager becomes invalid once the Java virtual
|
||||
* machine removes it from the memory system.
|
||||
*
|
||||
* @return <tt>true</tt> if the memory manager is valid in the
|
||||
* @return {@code true} if the memory manager is valid in the
|
||||
* Java virtual machine;
|
||||
* <tt>false</tt> otherwise.
|
||||
* {@code false} otherwise.
|
||||
*/
|
||||
public boolean isValid();
|
||||
|
||||
/**
|
||||
* Returns the name of memory pools that this memory manager manages.
|
||||
*
|
||||
* @return an array of <tt>String</tt> objects, each is
|
||||
* @return an array of {@code String} objects, each is
|
||||
* the name of a memory pool that this memory manager manages.
|
||||
*/
|
||||
public String[] getMemoryPoolNames();
|
||||
|
@ -53,12 +53,12 @@ import sun.management.MemoryNotifInfoCompositeData;
|
||||
*
|
||||
* <p>
|
||||
* A {@link CompositeData CompositeData} representing
|
||||
* the <tt>MemoryNotificationInfo</tt> object
|
||||
* the {@code MemoryNotificationInfo} object
|
||||
* is stored in the
|
||||
* {@link javax.management.Notification#setUserData user data}
|
||||
* of a {@link javax.management.Notification notification}.
|
||||
* The {@link #from from} method is provided to convert from
|
||||
* a <tt>CompositeData</tt> to a <tt>MemoryNotificationInfo</tt>
|
||||
* a {@code CompositeData} to a {@code MemoryNotificationInfo}
|
||||
* object. For example:
|
||||
*
|
||||
* <blockquote><pre>
|
||||
@ -78,7 +78,7 @@ import sun.management.MemoryNotifInfoCompositeData;
|
||||
* </pre></blockquote>
|
||||
*
|
||||
* <p>
|
||||
* The types of notifications emitted by <tt>MemoryMXBean</tt> are:
|
||||
* The types of notifications emitted by {@code MemoryMXBean} are:
|
||||
* <ul>
|
||||
* <li>A {@link #MEMORY_THRESHOLD_EXCEEDED
|
||||
* usage threshold exceeded notification}.
|
||||
@ -119,7 +119,7 @@ public class MemoryNotificationInfo {
|
||||
* further notification until the memory usage has returned
|
||||
* to become less than the usage threshold value.
|
||||
* The value of this notification type is
|
||||
* <tt>java.management.memory.threshold.exceeded</tt>.
|
||||
* {@code java.management.memory.threshold.exceeded}.
|
||||
*/
|
||||
public static final String MEMORY_THRESHOLD_EXCEEDED =
|
||||
"java.management.memory.threshold.exceeded";
|
||||
@ -133,13 +133,13 @@ public class MemoryNotificationInfo {
|
||||
* memory pool.
|
||||
* This notification is emitted by {@link MemoryMXBean}.
|
||||
* The value of this notification type is
|
||||
* <tt>java.management.memory.collection.threshold.exceeded</tt>.
|
||||
* {@code java.management.memory.collection.threshold.exceeded}.
|
||||
*/
|
||||
public static final String MEMORY_COLLECTION_THRESHOLD_EXCEEDED =
|
||||
"java.management.memory.collection.threshold.exceeded";
|
||||
|
||||
/**
|
||||
* Constructs a <tt>MemoryNotificationInfo</tt> object.
|
||||
* Constructs a {@code MemoryNotificationInfo} object.
|
||||
*
|
||||
* @param poolName The name of the memory pool which triggers this notification.
|
||||
* @param usage Memory usage of the memory pool.
|
||||
@ -207,9 +207,9 @@ public class MemoryNotificationInfo {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a <tt>MemoryNotificationInfo</tt> object represented by the
|
||||
* given <tt>CompositeData</tt>.
|
||||
* The given <tt>CompositeData</tt> must contain
|
||||
* Returns a {@code MemoryNotificationInfo} object represented by the
|
||||
* given {@code CompositeData}.
|
||||
* The given {@code CompositeData} must contain
|
||||
* the following attributes:
|
||||
* <blockquote>
|
||||
* <table border summary="The attributes and the types the given CompositeData contains">
|
||||
@ -219,28 +219,28 @@ public class MemoryNotificationInfo {
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td>poolName</td>
|
||||
* <td><tt>java.lang.String</tt></td>
|
||||
* <td>{@code java.lang.String}</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td>usage</td>
|
||||
* <td><tt>javax.management.openmbean.CompositeData</tt></td>
|
||||
* <td>{@code javax.management.openmbean.CompositeData}</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td>count</td>
|
||||
* <td><tt>java.lang.Long</tt></td>
|
||||
* <td>{@code java.lang.Long}</td>
|
||||
* </tr>
|
||||
* </table>
|
||||
* </blockquote>
|
||||
*
|
||||
* @param cd <tt>CompositeData</tt> representing a
|
||||
* <tt>MemoryNotificationInfo</tt>
|
||||
* @param cd {@code CompositeData} representing a
|
||||
* {@code MemoryNotificationInfo}
|
||||
*
|
||||
* @throws IllegalArgumentException if <tt>cd</tt> does not
|
||||
* represent a <tt>MemoryNotificationInfo</tt> object.
|
||||
* @throws IllegalArgumentException if {@code cd} does not
|
||||
* represent a {@code MemoryNotificationInfo} object.
|
||||
*
|
||||
* @return a <tt>MemoryNotificationInfo</tt> object represented
|
||||
* by <tt>cd</tt> if <tt>cd</tt> is not <tt>null</tt>;
|
||||
* <tt>null</tt> otherwise.
|
||||
* @return a {@code MemoryNotificationInfo} object represented
|
||||
* by {@code cd} if {@code cd} is not {@code null};
|
||||
* {@code null} otherwise.
|
||||
*/
|
||||
public static MemoryNotificationInfo from(CompositeData cd) {
|
||||
if (cd == null) {
|
||||
|
@ -37,13 +37,13 @@ package java.lang.management;
|
||||
* that can be obtained by calling
|
||||
* the {@link ManagementFactory#getMemoryPoolMXBeans} method or
|
||||
* from the {@link ManagementFactory#getPlatformMBeanServer
|
||||
* platform <tt>MBeanServer</tt>} method.
|
||||
* platform MBeanServer} method.
|
||||
*
|
||||
* <p>The <tt>ObjectName</tt> for uniquely identifying the MXBean for
|
||||
* a memory pool within an <tt>MBeanServer</tt> is:
|
||||
* <p>The {@code ObjectName} for uniquely identifying the MXBean for
|
||||
* a memory pool within an {@code MBeanServer} is:
|
||||
* <blockquote>
|
||||
* {@link ManagementFactory#MEMORY_POOL_MXBEAN_DOMAIN_TYPE
|
||||
* <tt>java.lang:type=MemoryPool</tt>}<tt>,name=</tt><i>pool's name</i>
|
||||
* java.lang:type=MemoryPool}{@code ,name=}<i>pool's name</i>
|
||||
* </blockquote>
|
||||
*
|
||||
* It can be obtained by calling the
|
||||
@ -236,7 +236,7 @@ package java.lang.management;
|
||||
* Usage threshold notification will be emitted by {@link MemoryMXBean}.
|
||||
* When the Java virtual machine detects that the memory usage of
|
||||
* a memory pool has reached or exceeded the usage threshold
|
||||
* the virtual machine will trigger the <tt>MemoryMXBean</tt> to emit an
|
||||
* the virtual machine will trigger the {@code MemoryMXBean} to emit an
|
||||
* {@link MemoryNotificationInfo#MEMORY_THRESHOLD_EXCEEDED
|
||||
* usage threshold exceeded notification}.
|
||||
* Another usage threshold exceeded notification will not be
|
||||
@ -250,7 +250,7 @@ package java.lang.management;
|
||||
* listener notifies another thread to perform the actual action
|
||||
* such as to redistribute outstanding tasks, stop receiving tasks,
|
||||
* or resume receiving tasks.
|
||||
* The <tt>handleNotification</tt> method should be designed to
|
||||
* The {@code handleNotification} method should be designed to
|
||||
* do a very minimal amount of work and return without delay to avoid
|
||||
* causing delay in delivering subsequent notifications. Time-consuming
|
||||
* actions should be performed by a separate thread.
|
||||
@ -290,7 +290,7 @@ package java.lang.management;
|
||||
* </pre>
|
||||
* <hr>
|
||||
* <p>
|
||||
* There is no guarantee about when the <tt>MemoryMXBean</tt> will emit
|
||||
* There is no guarantee about when the {@code MemoryMXBean} will emit
|
||||
* a threshold notification and when the notification will be delivered.
|
||||
* When a notification listener is invoked, the memory usage of
|
||||
* the memory pool may have crossed the usage threshold more
|
||||
@ -374,8 +374,8 @@ public interface MemoryPoolMXBean extends PlatformManagedObject {
|
||||
*
|
||||
* <p>
|
||||
* <b>MBeanServer access</b>:<br>
|
||||
* The mapped type of <tt>MemoryType</tt> is <tt>String</tt>
|
||||
* and the value is the name of the <tt>MemoryType</tt>.
|
||||
* The mapped type of {@code MemoryType} is {@code String}
|
||||
* and the value is the name of the {@code MemoryType}.
|
||||
*
|
||||
* @return the type of this memory pool.
|
||||
*/
|
||||
@ -383,7 +383,7 @@ public interface MemoryPoolMXBean extends PlatformManagedObject {
|
||||
|
||||
/**
|
||||
* Returns an estimate of the memory usage of this memory pool.
|
||||
* This method returns <tt>null</tt>
|
||||
* This method returns {@code null}
|
||||
* if this memory pool is not valid (i.e. no longer exists).
|
||||
*
|
||||
* <p>
|
||||
@ -399,11 +399,11 @@ public interface MemoryPoolMXBean extends PlatformManagedObject {
|
||||
*
|
||||
* <p>
|
||||
* <b>MBeanServer access</b>:<br>
|
||||
* The mapped type of <tt>MemoryUsage</tt> is
|
||||
* <tt>CompositeData</tt> with attributes as specified in
|
||||
* The mapped type of {@code MemoryUsage} is
|
||||
* {@code CompositeData} with attributes as specified in
|
||||
* {@link MemoryUsage#from MemoryUsage}.
|
||||
*
|
||||
* @return a {@link MemoryUsage} object; or <tt>null</tt> if
|
||||
* @return a {@link MemoryUsage} object; or {@code null} if
|
||||
* this pool not valid.
|
||||
*/
|
||||
public MemoryUsage getUsage();
|
||||
@ -411,17 +411,17 @@ public interface MemoryPoolMXBean extends PlatformManagedObject {
|
||||
/**
|
||||
* Returns the peak memory usage of this memory pool since the
|
||||
* Java virtual machine was started or since the peak was reset.
|
||||
* This method returns <tt>null</tt>
|
||||
* This method returns {@code null}
|
||||
* if this memory pool is not valid (i.e. no longer exists).
|
||||
*
|
||||
* <p>
|
||||
* <b>MBeanServer access</b>:<br>
|
||||
* The mapped type of <tt>MemoryUsage</tt> is
|
||||
* <tt>CompositeData</tt> with attributes as specified in
|
||||
* The mapped type of {@code MemoryUsage} is
|
||||
* {@code CompositeData} with attributes as specified in
|
||||
* {@link MemoryUsage#from MemoryUsage}.
|
||||
*
|
||||
* @return a {@link MemoryUsage} object representing the peak
|
||||
* memory usage; or <tt>null</tt> if this pool is not valid.
|
||||
* memory usage; or {@code null} if this pool is not valid.
|
||||
*
|
||||
*/
|
||||
public MemoryUsage getPeakUsage();
|
||||
@ -441,9 +441,9 @@ public interface MemoryPoolMXBean extends PlatformManagedObject {
|
||||
* machine. A memory pool becomes invalid once the Java virtual
|
||||
* machine removes it from the memory system.
|
||||
*
|
||||
* @return <tt>true</tt> if the memory pool is valid in the running
|
||||
* @return {@code true} if the memory pool is valid in the running
|
||||
* Java virtual machine;
|
||||
* <tt>false</tt> otherwise.
|
||||
* {@code false} otherwise.
|
||||
*/
|
||||
public boolean isValid();
|
||||
|
||||
@ -451,7 +451,7 @@ public interface MemoryPoolMXBean extends PlatformManagedObject {
|
||||
* Returns the name of memory managers that manages this memory pool.
|
||||
* Each memory pool will be managed by at least one memory manager.
|
||||
*
|
||||
* @return an array of <tt>String</tt> objects, each is the name of
|
||||
* @return an array of {@code String} objects, each is the name of
|
||||
* a memory manager managing this memory pool.
|
||||
*/
|
||||
public String[] getMemoryManagerNames();
|
||||
@ -472,7 +472,7 @@ public interface MemoryPoolMXBean extends PlatformManagedObject {
|
||||
public long getUsageThreshold();
|
||||
|
||||
/**
|
||||
* Sets the threshold of this memory pool to the given <tt>threshold</tt>
|
||||
* Sets the threshold of this memory pool to the given {@code threshold}
|
||||
* value if this memory pool supports the usage threshold.
|
||||
* The usage threshold crossing checking is enabled in this memory pool
|
||||
* if the threshold is set to a positive value.
|
||||
@ -481,7 +481,7 @@ public interface MemoryPoolMXBean extends PlatformManagedObject {
|
||||
*
|
||||
* @param threshold the new threshold value in bytes. Must be non-negative.
|
||||
*
|
||||
* @throws IllegalArgumentException if <tt>threshold</tt> is negative
|
||||
* @throws IllegalArgumentException if {@code threshold} is negative
|
||||
* or greater than the maximum amount of memory for
|
||||
* this memory pool if defined.
|
||||
*
|
||||
@ -501,9 +501,9 @@ public interface MemoryPoolMXBean extends PlatformManagedObject {
|
||||
* Tests if the memory usage of this memory pool
|
||||
* reaches or exceeds its usage threshold value.
|
||||
*
|
||||
* @return <tt>true</tt> if the memory usage of
|
||||
* @return {@code true} if the memory usage of
|
||||
* this memory pool reaches or exceeds the threshold value;
|
||||
* <tt>false</tt> otherwise.
|
||||
* {@code false} otherwise.
|
||||
*
|
||||
* @throws UnsupportedOperationException if this memory pool
|
||||
* does not support a usage threshold.
|
||||
@ -525,8 +525,8 @@ public interface MemoryPoolMXBean extends PlatformManagedObject {
|
||||
/**
|
||||
* Tests if this memory pool supports usage threshold.
|
||||
*
|
||||
* @return <tt>true</tt> if this memory pool supports usage threshold;
|
||||
* <tt>false</tt> otherwise.
|
||||
* @return {@code true} if this memory pool supports usage threshold;
|
||||
* {@code false} otherwise.
|
||||
*/
|
||||
public boolean isUsageThresholdSupported();
|
||||
|
||||
@ -547,7 +547,7 @@ public interface MemoryPoolMXBean extends PlatformManagedObject {
|
||||
|
||||
/**
|
||||
* Sets the collection usage threshold of this memory pool to
|
||||
* the given <tt>threshold</tt> value.
|
||||
* the given {@code threshold} value.
|
||||
* When this threshold is set to positive, the Java virtual machine
|
||||
* will check the memory usage at its best appropriate time after it has
|
||||
* expended effort in recycling unused objects in this memory pool.
|
||||
@ -560,7 +560,7 @@ public interface MemoryPoolMXBean extends PlatformManagedObject {
|
||||
* @param threshold the new collection usage threshold value in bytes.
|
||||
* Must be non-negative.
|
||||
*
|
||||
* @throws IllegalArgumentException if <tt>threshold</tt> is negative
|
||||
* @throws IllegalArgumentException if {@code threshold} is negative
|
||||
* or greater than the maximum amount of memory for
|
||||
* this memory pool if defined.
|
||||
*
|
||||
@ -585,10 +585,10 @@ public interface MemoryPoolMXBean extends PlatformManagedObject {
|
||||
* machine to perform any garbage collection other than its normal
|
||||
* automatic memory management.
|
||||
*
|
||||
* @return <tt>true</tt> if the memory usage of this memory pool
|
||||
* @return {@code true} if the memory usage of this memory pool
|
||||
* reaches or exceeds the collection usage threshold value
|
||||
* in the most recent collection;
|
||||
* <tt>false</tt> otherwise.
|
||||
* {@code false} otherwise.
|
||||
*
|
||||
* @throws UnsupportedOperationException if this memory pool
|
||||
* does not support a usage threshold.
|
||||
@ -617,27 +617,27 @@ public interface MemoryPoolMXBean extends PlatformManagedObject {
|
||||
* This method does not request the Java virtual
|
||||
* machine to perform any garbage collection other than its normal
|
||||
* automatic memory management.
|
||||
* This method returns <tt>null</tt> if the Java virtual
|
||||
* This method returns {@code null} if the Java virtual
|
||||
* machine does not support this method.
|
||||
*
|
||||
* <p>
|
||||
* <b>MBeanServer access</b>:<br>
|
||||
* The mapped type of <tt>MemoryUsage</tt> is
|
||||
* <tt>CompositeData</tt> with attributes as specified in
|
||||
* The mapped type of {@code MemoryUsage} is
|
||||
* {@code CompositeData} with attributes as specified in
|
||||
* {@link MemoryUsage#from MemoryUsage}.
|
||||
*
|
||||
* @return a {@link MemoryUsage} representing the memory usage of
|
||||
* this memory pool after the Java virtual machine most recently
|
||||
* expended effort in recycling unused objects;
|
||||
* <tt>null</tt> if this method is not supported.
|
||||
* {@code null} if this method is not supported.
|
||||
*/
|
||||
public MemoryUsage getCollectionUsage();
|
||||
|
||||
/**
|
||||
* Tests if this memory pool supports a collection usage threshold.
|
||||
*
|
||||
* @return <tt>true</tt> if this memory pool supports the
|
||||
* collection usage threshold; <tt>false</tt> otherwise.
|
||||
* @return {@code true} if this memory pool supports the
|
||||
* collection usage threshold; {@code false} otherwise.
|
||||
*/
|
||||
public boolean isCollectionUsageThresholdSupported();
|
||||
}
|
||||
|
@ -62,8 +62,8 @@ public enum MemoryType {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the string representation of this <tt>MemoryType</tt>.
|
||||
* @return the string representation of this <tt>MemoryType</tt>.
|
||||
* Returns the string representation of this {@code MemoryType}.
|
||||
* @return the string representation of this {@code MemoryType}.
|
||||
*/
|
||||
public String toString() {
|
||||
return description;
|
||||
|
@ -29,50 +29,50 @@ import javax.management.openmbean.CompositeData;
|
||||
import sun.management.MemoryUsageCompositeData;
|
||||
|
||||
/**
|
||||
* A <tt>MemoryUsage</tt> object represents a snapshot of memory usage.
|
||||
* Instances of the <tt>MemoryUsage</tt> class are usually constructed
|
||||
* A {@code MemoryUsage} object represents a snapshot of memory usage.
|
||||
* Instances of the {@code MemoryUsage} class are usually constructed
|
||||
* by methods that are used to obtain memory usage
|
||||
* information about individual memory pool of the Java virtual machine or
|
||||
* the heap or non-heap memory of the Java virtual machine as a whole.
|
||||
*
|
||||
* <p> A <tt>MemoryUsage</tt> object contains four values:
|
||||
* <p> A {@code MemoryUsage} object contains four values:
|
||||
* <table summary="Describes the MemoryUsage object content">
|
||||
* <tr>
|
||||
* <td valign=top> <tt>init</tt> </td>
|
||||
* <td valign=top> {@code init} </td>
|
||||
* <td valign=top> represents the initial amount of memory (in bytes) that
|
||||
* the Java virtual machine requests from the operating system
|
||||
* for memory management during startup. The Java virtual machine
|
||||
* may request additional memory from the operating system and
|
||||
* may also release memory to the system over time.
|
||||
* The value of <tt>init</tt> may be undefined.
|
||||
* The value of {@code init} may be undefined.
|
||||
* </td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td valign=top> <tt>used</tt> </td>
|
||||
* <td valign=top> {@code used} </td>
|
||||
* <td valign=top> represents the amount of memory currently used (in bytes).
|
||||
* </td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td valign=top> <tt>committed</tt> </td>
|
||||
* <td valign=top> {@code committed} </td>
|
||||
* <td valign=top> represents the amount of memory (in bytes) that is
|
||||
* guaranteed to be available for use by the Java virtual machine.
|
||||
* The amount of committed memory may change over time (increase
|
||||
* or decrease). The Java virtual machine may release memory to
|
||||
* the system and <tt>committed</tt> could be less than <tt>init</tt>.
|
||||
* <tt>committed</tt> will always be greater than
|
||||
* or equal to <tt>used</tt>.
|
||||
* the system and {@code committed} could be less than {@code init}.
|
||||
* {@code committed} will always be greater than
|
||||
* or equal to {@code used}.
|
||||
* </td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td valign=top> <tt>max</tt> </td>
|
||||
* <td valign=top> {@code max} </td>
|
||||
* <td valign=top> represents the maximum amount of memory (in bytes)
|
||||
* that can be used for memory management. Its value may be undefined.
|
||||
* The maximum amount of memory may change over time if defined.
|
||||
* The amount of used and committed memory will always be less than
|
||||
* or equal to <tt>max</tt> if <tt>max</tt> is defined.
|
||||
* or equal to {@code max} if {@code max} is defined.
|
||||
* A memory allocation may fail if it attempts to increase the
|
||||
* used memory such that <tt>used > committed</tt> even
|
||||
* if <tt>used <= max</tt> would still be true (for example,
|
||||
* used memory such that {@code used > committed} even
|
||||
* if {@code used <= max} would still be true (for example,
|
||||
* when the system is low on virtual memory).
|
||||
* </td>
|
||||
* </tr>
|
||||
@ -97,7 +97,7 @@ import sun.management.MemoryUsageCompositeData;
|
||||
* </pre>
|
||||
*
|
||||
* <h3>MXBean Mapping</h3>
|
||||
* <tt>MemoryUsage</tt> is mapped to a {@link CompositeData CompositeData}
|
||||
* {@code MemoryUsage} is mapped to a {@link CompositeData CompositeData}
|
||||
* with attributes as specified in the {@link #from from} method.
|
||||
*
|
||||
* @author Mandy Chung
|
||||
@ -110,26 +110,26 @@ public class MemoryUsage {
|
||||
private final long max;
|
||||
|
||||
/**
|
||||
* Constructs a <tt>MemoryUsage</tt> object.
|
||||
* Constructs a {@code MemoryUsage} object.
|
||||
*
|
||||
* @param init the initial amount of memory in bytes that
|
||||
* the Java virtual machine allocates;
|
||||
* or <tt>-1</tt> if undefined.
|
||||
* or {@code -1} if undefined.
|
||||
* @param used the amount of used memory in bytes.
|
||||
* @param committed the amount of committed memory in bytes.
|
||||
* @param max the maximum amount of memory in bytes that
|
||||
* can be used; or <tt>-1</tt> if undefined.
|
||||
* can be used; or {@code -1} if undefined.
|
||||
*
|
||||
* @throws IllegalArgumentException if
|
||||
* <ul>
|
||||
* <li> the value of <tt>init</tt> or <tt>max</tt> is negative
|
||||
* but not <tt>-1</tt>; or</li>
|
||||
* <li> the value of <tt>used</tt> or <tt>committed</tt> is negative;
|
||||
* <li> the value of {@code init} or {@code max} is negative
|
||||
* but not {@code -1}; or</li>
|
||||
* <li> the value of {@code used} or {@code committed} is negative;
|
||||
* or</li>
|
||||
* <li> <tt>used</tt> is greater than the value of <tt>committed</tt>;
|
||||
* <li> {@code used} is greater than the value of {@code committed};
|
||||
* or</li>
|
||||
* <li> <tt>committed</tt> is greater than the value of <tt>max</tt>
|
||||
* <tt>max</tt> if defined.</li>
|
||||
* <li> {@code committed} is greater than the value of {@code max}
|
||||
* {@code max} if defined.</li>
|
||||
* </ul>
|
||||
*/
|
||||
public MemoryUsage(long init,
|
||||
@ -168,7 +168,7 @@ public class MemoryUsage {
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs a <tt>MemoryUsage</tt> object from a
|
||||
* Constructs a {@code MemoryUsage} object from a
|
||||
* {@link CompositeData CompositeData}.
|
||||
*/
|
||||
private MemoryUsage(CompositeData cd) {
|
||||
@ -184,10 +184,10 @@ public class MemoryUsage {
|
||||
/**
|
||||
* Returns the amount of memory in bytes that the Java virtual machine
|
||||
* initially requests from the operating system for memory management.
|
||||
* This method returns <tt>-1</tt> if the initial memory size is undefined.
|
||||
* This method returns {@code -1} if the initial memory size is undefined.
|
||||
*
|
||||
* @return the initial size of memory in bytes;
|
||||
* <tt>-1</tt> if undefined.
|
||||
* {@code -1} if undefined.
|
||||
*/
|
||||
public long getInit() {
|
||||
return init;
|
||||
@ -217,7 +217,7 @@ public class MemoryUsage {
|
||||
|
||||
/**
|
||||
* Returns the maximum amount of memory in bytes that can be
|
||||
* used for memory management. This method returns <tt>-1</tt>
|
||||
* used for memory management. This method returns {@code -1}
|
||||
* if the maximum memory size is undefined.
|
||||
*
|
||||
* <p> This amount of memory is not guaranteed to be available
|
||||
@ -227,7 +227,7 @@ public class MemoryUsage {
|
||||
* maximum size.
|
||||
*
|
||||
* @return the maximum amount of memory in bytes;
|
||||
* <tt>-1</tt> if undefined.
|
||||
* {@code -1} if undefined.
|
||||
*/
|
||||
public long getMax() {
|
||||
return max;
|
||||
@ -247,8 +247,8 @@ public class MemoryUsage {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a <tt>MemoryUsage</tt> object represented by the
|
||||
* given <tt>CompositeData</tt>. The given <tt>CompositeData</tt>
|
||||
* Returns a {@code MemoryUsage} object represented by the
|
||||
* given {@code CompositeData}. The given {@code CompositeData}
|
||||
* must contain the following attributes:
|
||||
*
|
||||
* <blockquote>
|
||||
@ -259,32 +259,32 @@ public class MemoryUsage {
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td>init</td>
|
||||
* <td><tt>java.lang.Long</tt></td>
|
||||
* <td>{@code java.lang.Long}</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td>used</td>
|
||||
* <td><tt>java.lang.Long</tt></td>
|
||||
* <td>{@code java.lang.Long}</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td>committed</td>
|
||||
* <td><tt>java.lang.Long</tt></td>
|
||||
* <td>{@code java.lang.Long}</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td>max</td>
|
||||
* <td><tt>java.lang.Long</tt></td>
|
||||
* <td>{@code java.lang.Long}</td>
|
||||
* </tr>
|
||||
* </table>
|
||||
* </blockquote>
|
||||
*
|
||||
* @param cd <tt>CompositeData</tt> representing a <tt>MemoryUsage</tt>
|
||||
* @param cd {@code CompositeData} representing a {@code MemoryUsage}
|
||||
*
|
||||
* @throws IllegalArgumentException if <tt>cd</tt> does not
|
||||
* represent a <tt>MemoryUsage</tt> with the attributes described
|
||||
* @throws IllegalArgumentException if {@code cd} does not
|
||||
* represent a {@code MemoryUsage} with the attributes described
|
||||
* above.
|
||||
*
|
||||
* @return a <tt>MemoryUsage</tt> object represented by <tt>cd</tt>
|
||||
* if <tt>cd</tt> is not <tt>null</tt>;
|
||||
* <tt>null</tt> otherwise.
|
||||
* @return a {@code MemoryUsage} object represented by {@code cd}
|
||||
* if {@code cd} is not {@code null};
|
||||
* {@code null} otherwise.
|
||||
*/
|
||||
public static MemoryUsage from(CompositeData cd) {
|
||||
if (cd == null) {
|
||||
|
@ -33,7 +33,7 @@ import sun.management.MonitorInfoCompositeData;
|
||||
* when entering a synchronization block or method on that object.
|
||||
*
|
||||
* <h3>MXBean Mapping</h3>
|
||||
* <tt>MonitorInfo</tt> is mapped to a {@link CompositeData CompositeData}
|
||||
* {@code MonitorInfo} is mapped to a {@link CompositeData CompositeData}
|
||||
* with attributes as specified in
|
||||
* the {@link #from from} method.
|
||||
*
|
||||
@ -46,7 +46,7 @@ public class MonitorInfo extends LockInfo {
|
||||
private StackTraceElement stackFrame;
|
||||
|
||||
/**
|
||||
* Construct a <tt>MonitorInfo</tt> object.
|
||||
* Construct a {@code MonitorInfo} object.
|
||||
*
|
||||
* @param className the fully qualified name of the class of the lock object.
|
||||
* @param identityHashCode the {@link System#identityHashCode
|
||||
@ -55,9 +55,9 @@ public class MonitorInfo extends LockInfo {
|
||||
* was locked.
|
||||
* @param stackFrame the stack frame that locked the object monitor.
|
||||
* @throws IllegalArgumentException if
|
||||
* <tt>stackDepth</tt> ≥ 0 but <tt>stackFrame</tt> is <tt>null</tt>,
|
||||
* or <tt>stackDepth</tt> < 0 but <tt>stackFrame</tt> is not
|
||||
* <tt>null</tt>.
|
||||
* {@code stackDepth} ≥ 0 but {@code stackFrame} is {@code null},
|
||||
* or {@code stackDepth} < 0 but {@code stackFrame} is not
|
||||
* {@code null}.
|
||||
*/
|
||||
public MonitorInfo(String className,
|
||||
int identityHashCode,
|
||||
@ -78,7 +78,7 @@ public class MonitorInfo extends LockInfo {
|
||||
|
||||
/**
|
||||
* Returns the depth in the stack trace where the object monitor
|
||||
* was locked. The depth is the index to the <tt>StackTraceElement</tt>
|
||||
* was locked. The depth is the index to the {@code StackTraceElement}
|
||||
* array returned in the {@link ThreadInfo#getStackTrace} method.
|
||||
*
|
||||
* @return the depth in the stack trace where the object monitor
|
||||
@ -91,17 +91,17 @@ public class MonitorInfo extends LockInfo {
|
||||
/**
|
||||
* Returns the stack frame that locked the object monitor.
|
||||
*
|
||||
* @return <tt>StackTraceElement</tt> that locked the object monitor,
|
||||
* or <tt>null</tt> if not available.
|
||||
* @return {@code StackTraceElement} that locked the object monitor,
|
||||
* or {@code null} if not available.
|
||||
*/
|
||||
public StackTraceElement getLockedStackFrame() {
|
||||
return stackFrame;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a <tt>MonitorInfo</tt> object represented by the
|
||||
* given <tt>CompositeData</tt>.
|
||||
* The given <tt>CompositeData</tt> must contain the following attributes
|
||||
* Returns a {@code MonitorInfo} object represented by the
|
||||
* given {@code CompositeData}.
|
||||
* The given {@code CompositeData} must contain the following attributes
|
||||
* as well as the attributes specified in the
|
||||
* <a href="LockInfo.html#MappedType">
|
||||
* mapped type</a> for the {@link LockInfo} class:
|
||||
@ -113,28 +113,28 @@ public class MonitorInfo extends LockInfo {
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td>lockedStackFrame</td>
|
||||
* <td><tt>CompositeData as specified in the
|
||||
* <td><code>CompositeData as specified in the
|
||||
* <a href="ThreadInfo.html#StackTrace">stackTrace</a>
|
||||
* attribute defined in the {@link ThreadInfo#from
|
||||
* ThreadInfo.from} method.
|
||||
* </tt></td>
|
||||
* </code></td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td>lockedStackDepth</td>
|
||||
* <td><tt>java.lang.Integer</tt></td>
|
||||
* <td>{@code java.lang.Integer}</td>
|
||||
* </tr>
|
||||
* </table>
|
||||
* </blockquote>
|
||||
*
|
||||
* @param cd <tt>CompositeData</tt> representing a <tt>MonitorInfo</tt>
|
||||
* @param cd {@code CompositeData} representing a {@code MonitorInfo}
|
||||
*
|
||||
* @throws IllegalArgumentException if <tt>cd</tt> does not
|
||||
* represent a <tt>MonitorInfo</tt> with the attributes described
|
||||
* @throws IllegalArgumentException if {@code cd} does not
|
||||
* represent a {@code MonitorInfo} with the attributes described
|
||||
* above.
|
||||
|
||||
* @return a <tt>MonitorInfo</tt> object represented
|
||||
* by <tt>cd</tt> if <tt>cd</tt> is not <tt>null</tt>;
|
||||
* <tt>null</tt> otherwise.
|
||||
* @return a {@code MonitorInfo} object represented
|
||||
* by {@code cd} if {@code cd} is not {@code null};
|
||||
* {@code null} otherwise.
|
||||
*/
|
||||
public static MonitorInfo from(CompositeData cd) {
|
||||
if (cd == null) {
|
||||
|
@ -35,13 +35,13 @@ package java.lang.management;
|
||||
* that can be obtained by calling
|
||||
* the {@link ManagementFactory#getOperatingSystemMXBean} method or
|
||||
* from the {@link ManagementFactory#getPlatformMBeanServer
|
||||
* platform <tt>MBeanServer</tt>} method.
|
||||
* platform MBeanServer} method.
|
||||
*
|
||||
* <p>The <tt>ObjectName</tt> for uniquely identifying the MXBean for
|
||||
* <p>The {@code ObjectName} for uniquely identifying the MXBean for
|
||||
* the operating system within an MBeanServer is:
|
||||
* <blockquote>
|
||||
* {@link ManagementFactory#OPERATING_SYSTEM_MXBEAN_NAME
|
||||
* <tt>java.lang:type=OperatingSystem</tt>}
|
||||
* java.lang:type=OperatingSystem}
|
||||
* </blockquote>
|
||||
*
|
||||
* It can be obtained by calling the
|
||||
@ -63,7 +63,7 @@ package java.lang.management;
|
||||
public interface OperatingSystemMXBean extends PlatformManagedObject {
|
||||
/**
|
||||
* Returns the operating system name.
|
||||
* This method is equivalent to <tt>System.getProperty("os.name")</tt>.
|
||||
* This method is equivalent to {@code System.getProperty("os.name")}.
|
||||
*
|
||||
* @return the operating system name.
|
||||
*
|
||||
@ -78,7 +78,7 @@ public interface OperatingSystemMXBean extends PlatformManagedObject {
|
||||
|
||||
/**
|
||||
* Returns the operating system architecture.
|
||||
* This method is equivalent to <tt>System.getProperty("os.arch")</tt>.
|
||||
* This method is equivalent to {@code System.getProperty("os.arch")}.
|
||||
*
|
||||
* @return the operating system architecture.
|
||||
*
|
||||
@ -93,7 +93,7 @@ public interface OperatingSystemMXBean extends PlatformManagedObject {
|
||||
|
||||
/**
|
||||
* Returns the operating system version.
|
||||
* This method is equivalent to <tt>System.getProperty("os.version")</tt>.
|
||||
* This method is equivalent to {@code System.getProperty("os.version")}.
|
||||
*
|
||||
* @return the operating system version.
|
||||
*
|
||||
|
@ -28,7 +28,7 @@ package java.lang.management;
|
||||
/**
|
||||
* The management interface for the {@linkplain java.util.logging logging} facility.
|
||||
*
|
||||
* <p>There is a single global instance of the <tt>PlatformLoggingMXBean</tt>.
|
||||
* <p>There is a single global instance of the {@code PlatformLoggingMXBean}.
|
||||
* The {@link java.lang.management.ManagementFactory#getPlatformMXBean(Class)
|
||||
* ManagementFactory.getPlatformMXBean} method can be used to obtain
|
||||
* the {@code PlatformLoggingMXBean} object as follows:
|
||||
@ -44,7 +44,7 @@ package java.lang.management;
|
||||
* {@link java.util.logging.LogManager#LOGGING_MXBEAN_NAME java.util.logging:type=Logging}
|
||||
* </pre>
|
||||
*
|
||||
* <p>The instance registered in the platform <tt>MBeanServer</tt> with
|
||||
* <p>The instance registered in the platform {@code MBeanServer} with
|
||||
* this {@code ObjectName} implements all attributes defined by
|
||||
* {@link java.util.logging.LoggingMXBean}.
|
||||
*
|
||||
|
@ -35,13 +35,13 @@ package java.lang.management;
|
||||
* that can be obtained by calling
|
||||
* the {@link ManagementFactory#getRuntimeMXBean} method or
|
||||
* from the {@link ManagementFactory#getPlatformMBeanServer
|
||||
* platform <tt>MBeanServer</tt>} method.
|
||||
* platform MBeanServer} method.
|
||||
*
|
||||
* <p>The <tt>ObjectName</tt> for uniquely identifying the MXBean for
|
||||
* <p>The {@code ObjectName} for uniquely identifying the MXBean for
|
||||
* the runtime system within an MBeanServer is:
|
||||
* <blockquote>
|
||||
* {@link ManagementFactory#RUNTIME_MXBEAN_NAME
|
||||
* <tt>java.lang:type=Runtime</tt>}
|
||||
* java.lang:type=Runtime}
|
||||
* </blockquote>
|
||||
*
|
||||
* It can be obtained by calling the
|
||||
@ -81,7 +81,7 @@ public interface RuntimeMXBean extends PlatformManagedObject {
|
||||
*
|
||||
* @throws java.lang.SecurityException
|
||||
* if a security manager exists and its
|
||||
* <code>checkPropertiesAccess</code> method doesn't allow access
|
||||
* {@code checkPropertiesAccess} method doesn't allow access
|
||||
* to this system property.
|
||||
* @see java.lang.SecurityManager#checkPropertyAccess(java.lang.String)
|
||||
* @see java.lang.System#getProperty
|
||||
@ -97,7 +97,7 @@ public interface RuntimeMXBean extends PlatformManagedObject {
|
||||
*
|
||||
* @throws java.lang.SecurityException
|
||||
* if a security manager exists and its
|
||||
* <code>checkPropertiesAccess</code> method doesn't allow access
|
||||
* {@code checkPropertiesAccess} method doesn't allow access
|
||||
* to this system property.
|
||||
* @see java.lang.SecurityManager#checkPropertyAccess(java.lang.String)
|
||||
* @see java.lang.System#getProperty
|
||||
@ -113,7 +113,7 @@ public interface RuntimeMXBean extends PlatformManagedObject {
|
||||
*
|
||||
* @throws java.lang.SecurityException
|
||||
* if a security manager exists and its
|
||||
* <code>checkPropertiesAccess</code> method doesn't allow access
|
||||
* {@code checkPropertiesAccess} method doesn't allow access
|
||||
* to this system property.
|
||||
* @see java.lang.SecurityManager#checkPropertyAccess(java.lang.String)
|
||||
* @see java.lang.System#getProperty
|
||||
@ -129,7 +129,7 @@ public interface RuntimeMXBean extends PlatformManagedObject {
|
||||
*
|
||||
* @throws java.lang.SecurityException
|
||||
* if a security manager exists and its
|
||||
* <code>checkPropertiesAccess</code> method doesn't allow access
|
||||
* {@code checkPropertiesAccess} method doesn't allow access
|
||||
* to this system property.
|
||||
* @see java.lang.SecurityManager#checkPropertyAccess(java.lang.String)
|
||||
* @see java.lang.System#getProperty
|
||||
@ -145,7 +145,7 @@ public interface RuntimeMXBean extends PlatformManagedObject {
|
||||
*
|
||||
* @throws java.lang.SecurityException
|
||||
* if a security manager exists and its
|
||||
* <code>checkPropertiesAccess</code> method doesn't allow access
|
||||
* {@code checkPropertiesAccess} method doesn't allow access
|
||||
* to this system property.
|
||||
* @see java.lang.SecurityManager#checkPropertyAccess(java.lang.String)
|
||||
* @see java.lang.System#getProperty
|
||||
@ -161,7 +161,7 @@ public interface RuntimeMXBean extends PlatformManagedObject {
|
||||
*
|
||||
* @throws java.lang.SecurityException
|
||||
* if a security manager exists and its
|
||||
* <code>checkPropertiesAccess</code> method doesn't allow access
|
||||
* {@code checkPropertiesAccess} method doesn't allow access
|
||||
* to this system property.
|
||||
* @see java.lang.SecurityManager#checkPropertyAccess(java.lang.String)
|
||||
* @see java.lang.System#getProperty
|
||||
@ -192,7 +192,7 @@ public interface RuntimeMXBean extends PlatformManagedObject {
|
||||
*
|
||||
* @throws java.lang.SecurityException
|
||||
* if a security manager exists and its
|
||||
* <code>checkPropertiesAccess</code> method doesn't allow access
|
||||
* {@code checkPropertiesAccess} method doesn't allow access
|
||||
* to this system property.
|
||||
* @see java.lang.SecurityManager#checkPropertyAccess(java.lang.String)
|
||||
* @see java.lang.System#getProperty
|
||||
@ -212,7 +212,7 @@ public interface RuntimeMXBean extends PlatformManagedObject {
|
||||
*
|
||||
* @throws java.lang.SecurityException
|
||||
* if a security manager exists and its
|
||||
* <code>checkPropertiesAccess</code> method doesn't allow access
|
||||
* {@code checkPropertiesAccess} method doesn't allow access
|
||||
* to this system property.
|
||||
* @see java.lang.SecurityManager#checkPropertyAccess(java.lang.String)
|
||||
* @see java.lang.System#getProperty
|
||||
@ -224,8 +224,8 @@ public interface RuntimeMXBean extends PlatformManagedObject {
|
||||
* mechanism used by the bootstrap class loader to search for class
|
||||
* files.
|
||||
*
|
||||
* @return <tt>true</tt> if the Java virtual machine supports the
|
||||
* class path mechanism; <tt>false</tt> otherwise.
|
||||
* @return {@code true} if the Java virtual machine supports the
|
||||
* class path mechanism; {@code false} otherwise.
|
||||
*/
|
||||
public boolean isBootClassPathSupported();
|
||||
|
||||
@ -256,7 +256,7 @@ public interface RuntimeMXBean extends PlatformManagedObject {
|
||||
|
||||
/**
|
||||
* Returns the input arguments passed to the Java virtual machine
|
||||
* which does not include the arguments to the <tt>main</tt> method.
|
||||
* which does not include the arguments to the {@code main} method.
|
||||
* This method returns an empty list if there is no input argument
|
||||
* to the Java virtual machine.
|
||||
* <p>
|
||||
@ -272,9 +272,9 @@ public interface RuntimeMXBean extends PlatformManagedObject {
|
||||
*
|
||||
* <p>
|
||||
* <b>MBeanServer access</b>:<br>
|
||||
* The mapped type of {@code List<String>} is <tt>String[]</tt>.
|
||||
* The mapped type of {@code List<String>} is {@code String[]}.
|
||||
*
|
||||
* @return a list of <tt>String</tt> objects; each element
|
||||
* @return a list of {@code String} objects; each element
|
||||
* is an argument passed to the Java virtual machine.
|
||||
*
|
||||
* @throws java.lang.SecurityException
|
||||
@ -304,7 +304,7 @@ public interface RuntimeMXBean extends PlatformManagedObject {
|
||||
* Returns a map of names and values of all system properties.
|
||||
* This method calls {@link System#getProperties} to get all
|
||||
* system properties. Properties whose name or value is not
|
||||
* a <tt>String</tt> are omitted.
|
||||
* a {@code String} are omitted.
|
||||
*
|
||||
* <p>
|
||||
* <b>MBeanServer access</b>:<br>
|
||||
@ -318,12 +318,12 @@ public interface RuntimeMXBean extends PlatformManagedObject {
|
||||
* <th>Item Type</th>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>key</tt></td>
|
||||
* <td><tt>String</tt></td>
|
||||
* <td>{@code key}</td>
|
||||
* <td>{@code String}</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>value</tt></td>
|
||||
* <td><tt>String</tt></td>
|
||||
* <td>{@code value}</td>
|
||||
* <td>{@code String}</td>
|
||||
* </tr>
|
||||
* </table>
|
||||
* </blockquote>
|
||||
@ -332,7 +332,7 @@ public interface RuntimeMXBean extends PlatformManagedObject {
|
||||
*
|
||||
* @throws java.lang.SecurityException
|
||||
* if a security manager exists and its
|
||||
* <code>checkPropertiesAccess</code> method doesn't allow access
|
||||
* {@code checkPropertiesAccess} method doesn't allow access
|
||||
* to the system properties.
|
||||
*/
|
||||
public java.util.Map<String, String> getSystemProperties();
|
||||
|
@ -37,13 +37,13 @@ import java.util.Map;
|
||||
* that can be obtained by calling
|
||||
* the {@link ManagementFactory#getThreadMXBean} method or
|
||||
* from the {@link ManagementFactory#getPlatformMBeanServer
|
||||
* platform <tt>MBeanServer</tt>} method.
|
||||
* platform MBeanServer} method.
|
||||
*
|
||||
* <p>The <tt>ObjectName</tt> for uniquely identifying the MXBean for
|
||||
* <p>The {@code ObjectName} for uniquely identifying the MXBean for
|
||||
* the thread system within an MBeanServer is:
|
||||
* <blockquote>
|
||||
* {@link ManagementFactory#THREAD_MXBEAN_NAME
|
||||
* <tt>java.lang:type=Threading</tt>}
|
||||
* java.lang:type=Threading}
|
||||
* </blockquote>
|
||||
*
|
||||
* It can be obtained by calling the
|
||||
@ -88,7 +88,7 @@ import java.util.Map;
|
||||
* When thread contention monitoring is enabled, the accumulated elapsed
|
||||
* time that the thread has blocked for synchronization or waited for
|
||||
* notification will be collected and returned in the
|
||||
* <a href="ThreadInfo.html#SyncStats"><tt>ThreadInfo</tt></a> object.
|
||||
* <a href="ThreadInfo.html#SyncStats">{@code ThreadInfo}</a> object.
|
||||
* <p>
|
||||
* The {@link #isThreadContentionMonitoringSupported} method can be used to
|
||||
* determine if a Java virtual machine supports thread contention monitoring.
|
||||
@ -106,7 +106,7 @@ import java.util.Map;
|
||||
* {@linkplain LockInfo <i>lock</i>} a thread is blocked to
|
||||
* acquire or waiting on and which locks the thread currently owns.
|
||||
* <p>
|
||||
* The <tt>ThreadMXBean</tt> interface provides the
|
||||
* The {@code ThreadMXBean} interface provides the
|
||||
* {@link #findMonitorDeadlockedThreads} and
|
||||
* {@link #findDeadlockedThreads} methods to find deadlocks in
|
||||
* the running application.
|
||||
@ -158,7 +158,7 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
* Some threads included in the returned array
|
||||
* may have been terminated when this method returns.
|
||||
*
|
||||
* @return an array of <tt>long</tt>, each is a thread ID.
|
||||
* @return an array of {@code long}, each is a thread ID.
|
||||
*
|
||||
* @throws java.lang.SecurityException if a security manager
|
||||
* exists and the caller does not have
|
||||
@ -168,34 +168,34 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
|
||||
/**
|
||||
* Returns the thread info for a thread of the specified
|
||||
* <tt>id</tt> with no stack trace.
|
||||
* {@code id} with no stack trace.
|
||||
* This method is equivalent to calling:
|
||||
* <blockquote>
|
||||
* {@link #getThreadInfo(long, int) getThreadInfo(id, 0);}
|
||||
* </blockquote>
|
||||
*
|
||||
* <p>
|
||||
* This method returns a <tt>ThreadInfo</tt> object representing
|
||||
* This method returns a {@code ThreadInfo} object representing
|
||||
* the thread information for the thread of the specified ID.
|
||||
* The stack trace, locked monitors, and locked synchronizers
|
||||
* in the returned <tt>ThreadInfo</tt> object will
|
||||
* in the returned {@code ThreadInfo} object will
|
||||
* be empty.
|
||||
*
|
||||
* If a thread of the given ID is not alive or does not exist,
|
||||
* this method will return <tt>null</tt>. A thread is alive if
|
||||
* this method will return {@code null}. A thread is alive if
|
||||
* it has been started and has not yet died.
|
||||
*
|
||||
* <p>
|
||||
* <b>MBeanServer access</b>:<br>
|
||||
* The mapped type of <tt>ThreadInfo</tt> is
|
||||
* <tt>CompositeData</tt> with attributes as specified in the
|
||||
* The mapped type of {@code ThreadInfo} is
|
||||
* {@code CompositeData} with attributes as specified in the
|
||||
* {@link ThreadInfo#from ThreadInfo.from} method.
|
||||
*
|
||||
* @param id the thread ID of the thread. Must be positive.
|
||||
*
|
||||
* @return a {@link ThreadInfo} object for the thread of the given ID
|
||||
* with no stack trace, no locked monitor and no synchronizer info;
|
||||
* <tt>null</tt> if the thread of the given ID is not alive or
|
||||
* {@code null} if the thread of the given ID is not alive or
|
||||
* it does not exist.
|
||||
*
|
||||
* @throws IllegalArgumentException if {@code id <= 0}.
|
||||
@ -207,26 +207,26 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
|
||||
/**
|
||||
* Returns the thread info for each thread
|
||||
* whose ID is in the input array <tt>ids</tt> with no stack trace.
|
||||
* whose ID is in the input array {@code ids} with no stack trace.
|
||||
* This method is equivalent to calling:
|
||||
* <blockquote><pre>
|
||||
* {@link #getThreadInfo(long[], int) getThreadInfo}(ids, 0);
|
||||
* </pre></blockquote>
|
||||
*
|
||||
* <p>
|
||||
* This method returns an array of the <tt>ThreadInfo</tt> objects.
|
||||
* This method returns an array of the {@code ThreadInfo} objects.
|
||||
* The stack trace, locked monitors, and locked synchronizers
|
||||
* in each <tt>ThreadInfo</tt> object will be empty.
|
||||
* in each {@code ThreadInfo} object will be empty.
|
||||
*
|
||||
* If a thread of a given ID is not alive or does not exist,
|
||||
* the corresponding element in the returned array will
|
||||
* contain <tt>null</tt>. A thread is alive if
|
||||
* contain {@code null}. A thread is alive if
|
||||
* it has been started and has not yet died.
|
||||
*
|
||||
* <p>
|
||||
* <b>MBeanServer access</b>:<br>
|
||||
* The mapped type of <tt>ThreadInfo</tt> is
|
||||
* <tt>CompositeData</tt> with attributes as specified in the
|
||||
* The mapped type of {@code ThreadInfo} is
|
||||
* {@code CompositeData} with attributes as specified in the
|
||||
* {@link ThreadInfo#from ThreadInfo.from} method.
|
||||
*
|
||||
* @param ids an array of thread IDs.
|
||||
@ -236,7 +236,7 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
* with no stack trace, no locked monitor and no synchronizer info.
|
||||
*
|
||||
* @throws IllegalArgumentException if any element in the input array
|
||||
* <tt>ids</tt> is {@code <= 0}.
|
||||
* {@code ids} is {@code <= 0}.
|
||||
* @throws java.lang.SecurityException if a security manager
|
||||
* exists and the caller does not have
|
||||
* ManagementPermission("monitor").
|
||||
@ -244,46 +244,46 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
public ThreadInfo[] getThreadInfo(long[] ids);
|
||||
|
||||
/**
|
||||
* Returns a thread info for a thread of the specified <tt>id</tt>,
|
||||
* Returns a thread info for a thread of the specified {@code id},
|
||||
* with stack trace of a specified number of stack trace elements.
|
||||
* The <tt>maxDepth</tt> parameter indicates the maximum number of
|
||||
* The {@code maxDepth} parameter indicates the maximum number of
|
||||
* {@link StackTraceElement} to be retrieved from the stack trace.
|
||||
* If <tt>maxDepth == Integer.MAX_VALUE</tt>, the entire stack trace of
|
||||
* If {@code maxDepth == Integer.MAX_VALUE}, the entire stack trace of
|
||||
* the thread will be dumped.
|
||||
* If <tt>maxDepth == 0</tt>, no stack trace of the thread
|
||||
* If {@code maxDepth == 0}, no stack trace of the thread
|
||||
* will be dumped.
|
||||
* This method does not obtain the locked monitors and locked
|
||||
* synchronizers of the thread.
|
||||
* <p>
|
||||
* When the Java virtual machine has no stack trace information
|
||||
* about a thread or <tt>maxDepth == 0</tt>,
|
||||
* about a thread or {@code maxDepth == 0},
|
||||
* the stack trace in the
|
||||
* <tt>ThreadInfo</tt> object will be an empty array of
|
||||
* <tt>StackTraceElement</tt>.
|
||||
* {@code ThreadInfo} object will be an empty array of
|
||||
* {@code StackTraceElement}.
|
||||
*
|
||||
* <p>
|
||||
* If a thread of the given ID is not alive or does not exist,
|
||||
* this method will return <tt>null</tt>. A thread is alive if
|
||||
* this method will return {@code null}. A thread is alive if
|
||||
* it has been started and has not yet died.
|
||||
*
|
||||
* <p>
|
||||
* <b>MBeanServer access</b>:<br>
|
||||
* The mapped type of <tt>ThreadInfo</tt> is
|
||||
* <tt>CompositeData</tt> with attributes as specified in the
|
||||
* The mapped type of {@code ThreadInfo} is
|
||||
* {@code CompositeData} with attributes as specified in the
|
||||
* {@link ThreadInfo#from ThreadInfo.from} method.
|
||||
*
|
||||
* @param id the thread ID of the thread. Must be positive.
|
||||
* @param maxDepth the maximum number of entries in the stack trace
|
||||
* to be dumped. <tt>Integer.MAX_VALUE</tt> could be used to request
|
||||
* to be dumped. {@code Integer.MAX_VALUE} could be used to request
|
||||
* the entire stack to be dumped.
|
||||
*
|
||||
* @return a {@link ThreadInfo} of the thread of the given ID
|
||||
* with no locked monitor and synchronizer info.
|
||||
* <tt>null</tt> if the thread of the given ID is not alive or
|
||||
* {@code null} if the thread of the given ID is not alive or
|
||||
* it does not exist.
|
||||
*
|
||||
* @throws IllegalArgumentException if {@code id <= 0}.
|
||||
* @throws IllegalArgumentException if <tt>maxDepth is negative</tt>.
|
||||
* @throws IllegalArgumentException if {@code maxDepth is negative}.
|
||||
* @throws java.lang.SecurityException if a security manager
|
||||
* exists and the caller does not have
|
||||
* ManagementPermission("monitor").
|
||||
@ -293,40 +293,40 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
|
||||
/**
|
||||
* Returns the thread info for each thread
|
||||
* whose ID is in the input array <tt>ids</tt>,
|
||||
* whose ID is in the input array {@code ids},
|
||||
* with stack trace of a specified number of stack trace elements.
|
||||
* The <tt>maxDepth</tt> parameter indicates the maximum number of
|
||||
* The {@code maxDepth} parameter indicates the maximum number of
|
||||
* {@link StackTraceElement} to be retrieved from the stack trace.
|
||||
* If <tt>maxDepth == Integer.MAX_VALUE</tt>, the entire stack trace of
|
||||
* If {@code maxDepth == Integer.MAX_VALUE}, the entire stack trace of
|
||||
* the thread will be dumped.
|
||||
* If <tt>maxDepth == 0</tt>, no stack trace of the thread
|
||||
* If {@code maxDepth == 0}, no stack trace of the thread
|
||||
* will be dumped.
|
||||
* This method does not obtain the locked monitors and locked
|
||||
* synchronizers of the threads.
|
||||
* <p>
|
||||
* When the Java virtual machine has no stack trace information
|
||||
* about a thread or <tt>maxDepth == 0</tt>,
|
||||
* about a thread or {@code maxDepth == 0},
|
||||
* the stack trace in the
|
||||
* <tt>ThreadInfo</tt> object will be an empty array of
|
||||
* <tt>StackTraceElement</tt>.
|
||||
* {@code ThreadInfo} object will be an empty array of
|
||||
* {@code StackTraceElement}.
|
||||
* <p>
|
||||
* This method returns an array of the <tt>ThreadInfo</tt> objects,
|
||||
* This method returns an array of the {@code ThreadInfo} objects,
|
||||
* each is the thread information about the thread with the same index
|
||||
* as in the <tt>ids</tt> array.
|
||||
* as in the {@code ids} array.
|
||||
* If a thread of the given ID is not alive or does not exist,
|
||||
* <tt>null</tt> will be set in the corresponding element
|
||||
* {@code null} will be set in the corresponding element
|
||||
* in the returned array. A thread is alive if
|
||||
* it has been started and has not yet died.
|
||||
*
|
||||
* <p>
|
||||
* <b>MBeanServer access</b>:<br>
|
||||
* The mapped type of <tt>ThreadInfo</tt> is
|
||||
* <tt>CompositeData</tt> with attributes as specified in the
|
||||
* The mapped type of {@code ThreadInfo} is
|
||||
* {@code CompositeData} with attributes as specified in the
|
||||
* {@link ThreadInfo#from ThreadInfo.from} method.
|
||||
*
|
||||
* @param ids an array of thread IDs
|
||||
* @param maxDepth the maximum number of entries in the stack trace
|
||||
* to be dumped. <tt>Integer.MAX_VALUE</tt> could be used to request
|
||||
* to be dumped. {@code Integer.MAX_VALUE} could be used to request
|
||||
* the entire stack to be dumped.
|
||||
*
|
||||
* @return an array of the {@link ThreadInfo} objects, each containing
|
||||
@ -334,9 +334,9 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
* element of the input array of IDs with no locked monitor and
|
||||
* synchronizer info.
|
||||
*
|
||||
* @throws IllegalArgumentException if <tt>maxDepth is negative</tt>.
|
||||
* @throws IllegalArgumentException if {@code maxDepth is negative}.
|
||||
* @throws IllegalArgumentException if any element in the input array
|
||||
* <tt>ids</tt> is {@code <= 0}.
|
||||
* {@code ids} is {@code <= 0}.
|
||||
* @throws java.lang.SecurityException if a security manager
|
||||
* exists and the caller does not have
|
||||
* ManagementPermission("monitor").
|
||||
@ -348,17 +348,17 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
* Tests if the Java virtual machine supports thread contention monitoring.
|
||||
*
|
||||
* @return
|
||||
* <tt>true</tt>
|
||||
* {@code true}
|
||||
* if the Java virtual machine supports thread contention monitoring;
|
||||
* <tt>false</tt> otherwise.
|
||||
* {@code false} otherwise.
|
||||
*/
|
||||
public boolean isThreadContentionMonitoringSupported();
|
||||
|
||||
/**
|
||||
* Tests if thread contention monitoring is enabled.
|
||||
*
|
||||
* @return <tt>true</tt> if thread contention monitoring is enabled;
|
||||
* <tt>false</tt> otherwise.
|
||||
* @return {@code true} if thread contention monitoring is enabled;
|
||||
* {@code false} otherwise.
|
||||
*
|
||||
* @throws java.lang.UnsupportedOperationException if the Java virtual
|
||||
* machine does not support thread contention monitoring.
|
||||
@ -371,8 +371,8 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
* Enables or disables thread contention monitoring.
|
||||
* Thread contention monitoring is disabled by default.
|
||||
*
|
||||
* @param enable <tt>true</tt> to enable;
|
||||
* <tt>false</tt> to disable.
|
||||
* @param enable {@code true} to enable;
|
||||
* {@code false} to disable.
|
||||
*
|
||||
* @throws java.lang.UnsupportedOperationException if the Java
|
||||
* virtual machine does not support thread contention monitoring.
|
||||
@ -401,7 +401,7 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
* </pre></blockquote>
|
||||
*
|
||||
* @return the total CPU time for the current thread if CPU time
|
||||
* measurement is enabled; <tt>-1</tt> otherwise.
|
||||
* measurement is enabled; {@code -1} otherwise.
|
||||
*
|
||||
* @throws java.lang.UnsupportedOperationException if the Java
|
||||
* virtual machine does not support CPU time measurement for
|
||||
@ -428,7 +428,7 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
* </pre></blockquote>
|
||||
*
|
||||
* @return the user-level CPU time for the current thread if CPU time
|
||||
* measurement is enabled; <tt>-1</tt> otherwise.
|
||||
* measurement is enabled; {@code -1} otherwise.
|
||||
*
|
||||
* @throws java.lang.UnsupportedOperationException if the Java
|
||||
* virtual machine does not support CPU time measurement for
|
||||
@ -451,8 +451,8 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
*
|
||||
* <p>
|
||||
* If the thread of the specified ID is not alive or does not exist,
|
||||
* this method returns <tt>-1</tt>. If CPU time measurement
|
||||
* is disabled, this method returns <tt>-1</tt>.
|
||||
* this method returns {@code -1}. If CPU time measurement
|
||||
* is disabled, this method returns {@code -1}.
|
||||
* A thread is alive if it has been started and has not yet died.
|
||||
* <p>
|
||||
* If CPU time measurement is enabled after the thread has started,
|
||||
@ -464,7 +464,7 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
* @return the total CPU time for a thread of the specified ID
|
||||
* if the thread of the specified ID exists, the thread is alive,
|
||||
* and CPU time measurement is enabled;
|
||||
* <tt>-1</tt> otherwise.
|
||||
* {@code -1} otherwise.
|
||||
*
|
||||
* @throws IllegalArgumentException if {@code id <= 0}.
|
||||
* @throws java.lang.UnsupportedOperationException if the Java
|
||||
@ -486,8 +486,8 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
*
|
||||
* <p>
|
||||
* If the thread of the specified ID is not alive or does not exist,
|
||||
* this method returns <tt>-1</tt>. If CPU time measurement
|
||||
* is disabled, this method returns <tt>-1</tt>.
|
||||
* this method returns {@code -1}. If CPU time measurement
|
||||
* is disabled, this method returns {@code -1}.
|
||||
* A thread is alive if it has been started and has not yet died.
|
||||
* <p>
|
||||
* If CPU time measurement is enabled after the thread has started,
|
||||
@ -499,7 +499,7 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
* @return the user-level CPU time for a thread of the specified ID
|
||||
* if the thread of the specified ID exists, the thread is alive,
|
||||
* and CPU time measurement is enabled;
|
||||
* <tt>-1</tt> otherwise.
|
||||
* {@code -1} otherwise.
|
||||
*
|
||||
* @throws IllegalArgumentException if {@code id <= 0}.
|
||||
* @throws java.lang.UnsupportedOperationException if the Java
|
||||
@ -521,32 +521,32 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
* measurement for the current thread.
|
||||
*
|
||||
* @return
|
||||
* <tt>true</tt>
|
||||
* {@code true}
|
||||
* if the Java virtual machine supports CPU time
|
||||
* measurement for any thread;
|
||||
* <tt>false</tt> otherwise.
|
||||
* {@code false} otherwise.
|
||||
*/
|
||||
public boolean isThreadCpuTimeSupported();
|
||||
|
||||
/**
|
||||
* Tests if the Java virtual machine supports CPU time
|
||||
* measurement for the current thread.
|
||||
* This method returns <tt>true</tt> if {@link #isThreadCpuTimeSupported}
|
||||
* returns <tt>true</tt>.
|
||||
* This method returns {@code true} if {@link #isThreadCpuTimeSupported}
|
||||
* returns {@code true}.
|
||||
*
|
||||
* @return
|
||||
* <tt>true</tt>
|
||||
* {@code true}
|
||||
* if the Java virtual machine supports CPU time
|
||||
* measurement for current thread;
|
||||
* <tt>false</tt> otherwise.
|
||||
* {@code false} otherwise.
|
||||
*/
|
||||
public boolean isCurrentThreadCpuTimeSupported();
|
||||
|
||||
/**
|
||||
* Tests if thread CPU time measurement is enabled.
|
||||
*
|
||||
* @return <tt>true</tt> if thread CPU time measurement is enabled;
|
||||
* <tt>false</tt> otherwise.
|
||||
* @return {@code true} if thread CPU time measurement is enabled;
|
||||
* {@code false} otherwise.
|
||||
*
|
||||
* @throws java.lang.UnsupportedOperationException if the Java virtual
|
||||
* machine does not support CPU time measurement for other threads
|
||||
@ -561,8 +561,8 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
* Enables or disables thread CPU time measurement. The default
|
||||
* is platform dependent.
|
||||
*
|
||||
* @param enable <tt>true</tt> to enable;
|
||||
* <tt>false</tt> to disable.
|
||||
* @param enable {@code true} to enable;
|
||||
* {@code false} to disable.
|
||||
*
|
||||
* @throws java.lang.UnsupportedOperationException if the Java
|
||||
* virtual machine does not support CPU time measurement for
|
||||
@ -602,7 +602,7 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
* should be used.
|
||||
*
|
||||
* @return an array of IDs of the threads that are monitor
|
||||
* deadlocked, if any; <tt>null</tt> otherwise.
|
||||
* deadlocked, if any; {@code null} otherwise.
|
||||
*
|
||||
* @throws java.lang.SecurityException if a security manager
|
||||
* exists and the caller does not have
|
||||
@ -640,7 +640,7 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
*
|
||||
* @return an array of IDs of the threads that are
|
||||
* deadlocked waiting for object monitors or ownable synchronizers, if any;
|
||||
* <tt>null</tt> otherwise.
|
||||
* {@code null} otherwise.
|
||||
*
|
||||
* @throws java.lang.SecurityException if a security manager
|
||||
* exists and the caller does not have
|
||||
@ -659,10 +659,10 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
* object monitor usage.
|
||||
*
|
||||
* @return
|
||||
* <tt>true</tt>
|
||||
* {@code true}
|
||||
* if the Java virtual machine supports monitoring of
|
||||
* object monitor usage;
|
||||
* <tt>false</tt> otherwise.
|
||||
* {@code false} otherwise.
|
||||
*
|
||||
* @see #dumpAllThreads
|
||||
* @since 1.6
|
||||
@ -675,10 +675,10 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
* ownable synchronizer</a> usage.
|
||||
*
|
||||
* @return
|
||||
* <tt>true</tt>
|
||||
* {@code true}
|
||||
* if the Java virtual machine supports monitoring of ownable
|
||||
* synchronizer usage;
|
||||
* <tt>false</tt> otherwise.
|
||||
* {@code false} otherwise.
|
||||
*
|
||||
* @see #dumpAllThreads
|
||||
* @since 1.6
|
||||
@ -687,7 +687,7 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
|
||||
/**
|
||||
* Returns the thread info for each thread
|
||||
* whose ID is in the input array <tt>ids</tt>, with stack trace
|
||||
* whose ID is in the input array {@code ids}, with stack trace
|
||||
* and synchronization information.
|
||||
*
|
||||
* <p>
|
||||
@ -696,30 +696,30 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
* <ul>
|
||||
* <li>the entire stack trace,</li>
|
||||
* <li>the object monitors currently locked by the thread
|
||||
* if <tt>lockedMonitors</tt> is <tt>true</tt>, and</li>
|
||||
* if {@code lockedMonitors} is {@code true}, and</li>
|
||||
* <li>the <a href="LockInfo.html#OwnableSynchronizer">
|
||||
* ownable synchronizers</a> currently locked by the thread
|
||||
* if <tt>lockedSynchronizers</tt> is <tt>true</tt>.</li>
|
||||
* if {@code lockedSynchronizers} is {@code true}.</li>
|
||||
* </ul>
|
||||
* <p>
|
||||
* This method returns an array of the <tt>ThreadInfo</tt> objects,
|
||||
* This method returns an array of the {@code ThreadInfo} objects,
|
||||
* each is the thread information about the thread with the same index
|
||||
* as in the <tt>ids</tt> array.
|
||||
* as in the {@code ids} array.
|
||||
* If a thread of the given ID is not alive or does not exist,
|
||||
* <tt>null</tt> will be set in the corresponding element
|
||||
* {@code null} will be set in the corresponding element
|
||||
* in the returned array. A thread is alive if
|
||||
* it has been started and has not yet died.
|
||||
* <p>
|
||||
* If a thread does not lock any object monitor or <tt>lockedMonitors</tt>
|
||||
* is <tt>false</tt>, the returned <tt>ThreadInfo</tt> object will have an
|
||||
* empty <tt>MonitorInfo</tt> array. Similarly, if a thread does not
|
||||
* lock any synchronizer or <tt>lockedSynchronizers</tt> is <tt>false</tt>,
|
||||
* the returned <tt>ThreadInfo</tt> object
|
||||
* will have an empty <tt>LockInfo</tt> array.
|
||||
* If a thread does not lock any object monitor or {@code lockedMonitors}
|
||||
* is {@code false}, the returned {@code ThreadInfo} object will have an
|
||||
* empty {@code MonitorInfo} array. Similarly, if a thread does not
|
||||
* lock any synchronizer or {@code lockedSynchronizers} is {@code false},
|
||||
* the returned {@code ThreadInfo} object
|
||||
* will have an empty {@code LockInfo} array.
|
||||
*
|
||||
* <p>
|
||||
* When both <tt>lockedMonitors</tt> and <tt>lockedSynchronizers</tt>
|
||||
* parameters are <tt>false</tt>, it is equivalent to calling:
|
||||
* When both {@code lockedMonitors} and {@code lockedSynchronizers}
|
||||
* parameters are {@code false}, it is equivalent to calling:
|
||||
* <blockquote><pre>
|
||||
* {@link #getThreadInfo(long[], int) getThreadInfo(ids, Integer.MAX_VALUE)}
|
||||
* </pre></blockquote>
|
||||
@ -730,13 +730,13 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
*
|
||||
* <p>
|
||||
* <b>MBeanServer access</b>:<br>
|
||||
* The mapped type of <tt>ThreadInfo</tt> is
|
||||
* <tt>CompositeData</tt> with attributes as specified in the
|
||||
* The mapped type of {@code ThreadInfo} is
|
||||
* {@code CompositeData} with attributes as specified in the
|
||||
* {@link ThreadInfo#from ThreadInfo.from} method.
|
||||
*
|
||||
* @param ids an array of thread IDs.
|
||||
* @param lockedMonitors if <tt>true</tt>, retrieves all locked monitors.
|
||||
* @param lockedSynchronizers if <tt>true</tt>, retrieves all locked
|
||||
* @param lockedMonitors if {@code true}, retrieves all locked monitors.
|
||||
* @param lockedSynchronizers if {@code true}, retrieves all locked
|
||||
* ownable synchronizers.
|
||||
*
|
||||
* @return an array of the {@link ThreadInfo} objects, each containing
|
||||
@ -748,11 +748,11 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
* ManagementPermission("monitor").
|
||||
* @throws java.lang.UnsupportedOperationException
|
||||
* <ul>
|
||||
* <li>if <tt>lockedMonitors</tt> is <tt>true</tt> but
|
||||
* <li>if {@code lockedMonitors} is {@code true} but
|
||||
* the Java virtual machine does not support monitoring
|
||||
* of {@linkplain #isObjectMonitorUsageSupported
|
||||
* object monitor usage}; or</li>
|
||||
* <li>if <tt>lockedSynchronizers</tt> is <tt>true</tt> but
|
||||
* <li>if {@code lockedSynchronizers} is {@code true} but
|
||||
* the Java virtual machine does not support monitoring
|
||||
* of {@linkplain #isSynchronizerUsageSupported
|
||||
* ownable synchronizer usage}.</li>
|
||||
@ -776,8 +776,8 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
* as specified in the {@link #getThreadInfo(long[], boolean, boolean)}
|
||||
* method.
|
||||
*
|
||||
* @param lockedMonitors if <tt>true</tt>, dump all locked monitors.
|
||||
* @param lockedSynchronizers if <tt>true</tt>, dump all locked
|
||||
* @param lockedMonitors if {@code true}, dump all locked monitors.
|
||||
* @param lockedSynchronizers if {@code true}, dump all locked
|
||||
* ownable synchronizers.
|
||||
*
|
||||
* @return an array of {@link ThreadInfo} for all live threads.
|
||||
@ -787,11 +787,11 @@ public interface ThreadMXBean extends PlatformManagedObject {
|
||||
* ManagementPermission("monitor").
|
||||
* @throws java.lang.UnsupportedOperationException
|
||||
* <ul>
|
||||
* <li>if <tt>lockedMonitors</tt> is <tt>true</tt> but
|
||||
* <li>if {@code lockedMonitors} is {@code true} but
|
||||
* the Java virtual machine does not support monitoring
|
||||
* of {@linkplain #isObjectMonitorUsageSupported
|
||||
* object monitor usage}; or</li>
|
||||
* <li>if <tt>lockedSynchronizers</tt> is <tt>true</tt> but
|
||||
* <li>if {@code lockedSynchronizers} is {@code true} but
|
||||
* the Java virtual machine does not support monitoring
|
||||
* of {@linkplain #isSynchronizerUsageSupported
|
||||
* ownable synchronizer usage}.</li>
|
||||
|
@ -169,7 +169,7 @@ Java virtual machine and the runtime in the following ways:
|
||||
the management interface by defining platform-dependent
|
||||
interfaces that extend the standard management interfaces to include
|
||||
platform-specific metrics and management operations.
|
||||
The static factory methods in the <tt>ManagementFactory</tt> class will
|
||||
The static factory methods in the <code>ManagementFactory</code> class will
|
||||
return the MXBeans with the platform extension.
|
||||
|
||||
<p>
|
||||
@ -205,7 +205,7 @@ from the platform extension:
|
||||
</blockquote>
|
||||
|
||||
<p>
|
||||
2) Access the Oracle-specific MXBean interface via <tt>MBeanServer</tt>
|
||||
2) Access the Oracle-specific MXBean interface via <code>MBeanServer</code>
|
||||
through proxy
|
||||
|
||||
<blockquote><pre>
|
||||
@ -228,7 +228,7 @@ from the platform extension:
|
||||
}
|
||||
</pre></blockquote>
|
||||
|
||||
<p> Unless otherwise noted, passing a <tt>null</tt> argument to a constructor
|
||||
<p> Unless otherwise noted, passing a <code>null</code> argument to a constructor
|
||||
or method in any class or interface in this package will cause a {@link
|
||||
java.lang.NullPointerException NullPointerException} to be thrown.
|
||||
|
||||
|
@ -92,7 +92,7 @@ public class MBeanAttributeInfo extends MBeanFeatureInfo implements Cloneable {
|
||||
|
||||
|
||||
/**
|
||||
* Constructs an <CODE>MBeanAttributeInfo</CODE> object.
|
||||
* Constructs an {@code MBeanAttributeInfo} object.
|
||||
*
|
||||
* @param name The name of the attribute.
|
||||
* @param type The type or class name of the attribute.
|
||||
@ -118,7 +118,7 @@ public class MBeanAttributeInfo extends MBeanFeatureInfo implements Cloneable {
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs an <CODE>MBeanAttributeInfo</CODE> object.
|
||||
* Constructs an {@code MBeanAttributeInfo} object.
|
||||
*
|
||||
* @param name The name of the attribute.
|
||||
* @param type The type or class name of the attribute.
|
||||
@ -193,9 +193,9 @@ public class MBeanAttributeInfo extends MBeanFeatureInfo implements Cloneable {
|
||||
|
||||
/**
|
||||
* <p>Returns a shallow clone of this instance.
|
||||
* The clone is obtained by simply calling <tt>super.clone()</tt>,
|
||||
* The clone is obtained by simply calling {@code super.clone()},
|
||||
* thus calling the default native shallow cloning mechanism
|
||||
* implemented by <tt>Object.clone()</tt>.
|
||||
* implemented by {@code Object.clone()}.
|
||||
* No deeper cloning of any internal field is made.</p>
|
||||
*
|
||||
* <p>Since this class is immutable, cloning is chiefly of
|
||||
@ -274,7 +274,7 @@ public class MBeanAttributeInfo extends MBeanFeatureInfo implements Cloneable {
|
||||
*
|
||||
* @param o the object to compare to.
|
||||
*
|
||||
* @return true if and only if <code>o</code> is an MBeanAttributeInfo such
|
||||
* @return true if and only if {@code o} is an MBeanAttributeInfo such
|
||||
* that its {@link #getName()}, {@link #getType()}, {@link
|
||||
* #getDescription()}, {@link #isReadable()}, {@link
|
||||
* #isWritable()}, and {@link #isIs()} values are equal (not
|
||||
|
@ -55,14 +55,14 @@ public class MBeanConstructorInfo extends MBeanFeatureInfo implements Cloneable
|
||||
private final MBeanParameterInfo[] signature;
|
||||
|
||||
/**
|
||||
* Constructs an <CODE>MBeanConstructorInfo</CODE> object. The
|
||||
* Constructs an {@code MBeanConstructorInfo} object. The
|
||||
* {@link Descriptor} of the constructed object will include
|
||||
* fields contributed by any annotations on the {@code
|
||||
* Constructor} object that contain the {@link DescriptorKey}
|
||||
* meta-annotation.
|
||||
*
|
||||
* @param description A human readable description of the operation.
|
||||
* @param constructor The <CODE>java.lang.reflect.Constructor</CODE>
|
||||
* @param constructor The {@code java.lang.reflect.Constructor}
|
||||
* object describing the MBean constructor.
|
||||
*/
|
||||
public MBeanConstructorInfo(String description, Constructor<?> constructor) {
|
||||
@ -72,10 +72,10 @@ public class MBeanConstructorInfo extends MBeanFeatureInfo implements Cloneable
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs an <CODE>MBeanConstructorInfo</CODE> object.
|
||||
* Constructs an {@code MBeanConstructorInfo} object.
|
||||
*
|
||||
* @param name The name of the constructor.
|
||||
* @param signature <CODE>MBeanParameterInfo</CODE> objects
|
||||
* @param signature {@code MBeanParameterInfo} objects
|
||||
* describing the parameters(arguments) of the constructor. This
|
||||
* may be null with the same effect as a zero-length array.
|
||||
* @param description A human readable description of the constructor.
|
||||
@ -87,10 +87,10 @@ public class MBeanConstructorInfo extends MBeanFeatureInfo implements Cloneable
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs an <CODE>MBeanConstructorInfo</CODE> object.
|
||||
* Constructs an {@code MBeanConstructorInfo} object.
|
||||
*
|
||||
* @param name The name of the constructor.
|
||||
* @param signature <CODE>MBeanParameterInfo</CODE> objects
|
||||
* @param signature {@code MBeanParameterInfo} objects
|
||||
* describing the parameters(arguments) of the constructor. This
|
||||
* may be null with the same effect as a zero-length array.
|
||||
* @param description A human readable description of the constructor.
|
||||
@ -118,9 +118,9 @@ public class MBeanConstructorInfo extends MBeanFeatureInfo implements Cloneable
|
||||
|
||||
/**
|
||||
* <p>Returns a shallow clone of this instance. The clone is
|
||||
* obtained by simply calling <tt>super.clone()</tt>, thus calling
|
||||
* obtained by simply calling {@code super.clone()}, thus calling
|
||||
* the default native shallow cloning mechanism implemented by
|
||||
* <tt>Object.clone()</tt>. No deeper cloning of any internal
|
||||
* {@code Object.clone()}. No deeper cloning of any internal
|
||||
* field is made.</p>
|
||||
*
|
||||
* <p>Since this class is immutable, cloning is chiefly of
|
||||
@ -137,16 +137,16 @@ public class MBeanConstructorInfo extends MBeanFeatureInfo implements Cloneable
|
||||
|
||||
/**
|
||||
* <p>Returns the list of parameters for this constructor. Each
|
||||
* parameter is described by an <CODE>MBeanParameterInfo</CODE>
|
||||
* parameter is described by an {@code MBeanParameterInfo}
|
||||
* object.</p>
|
||||
*
|
||||
* <p>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 <CODE>MBeanParameterInfo</CODE> objects but
|
||||
* that each referenced <CODE>MBeanParameterInfo</CODE> object is
|
||||
* references to the {@code MBeanParameterInfo} objects but
|
||||
* that each referenced {@code MBeanParameterInfo} object is
|
||||
* not copied.</p>
|
||||
*
|
||||
* @return An array of <CODE>MBeanParameterInfo</CODE> objects.
|
||||
* @return An array of {@code MBeanParameterInfo} objects.
|
||||
*/
|
||||
public MBeanParameterInfo[] getSignature() {
|
||||
if (signature.length == 0)
|
||||
@ -177,7 +177,7 @@ public class MBeanConstructorInfo extends MBeanFeatureInfo implements Cloneable
|
||||
*
|
||||
* @param o the object to compare to.
|
||||
*
|
||||
* @return true if and only if <code>o</code> is an MBeanConstructorInfo such
|
||||
* @return true if and only if {@code o} is an MBeanConstructorInfo such
|
||||
* that its {@link #getName()}, {@link #getDescription()},
|
||||
* {@link #getSignature()}, and {@link #getDescriptor()}
|
||||
* values are equal (not necessarily
|
||||
|
@ -57,12 +57,12 @@ import static javax.management.ImmutableDescriptor.nonNullDescriptor;
|
||||
* <a href="Descriptor.html#infoTimeout">infoTimeout</a> fields in the {@code
|
||||
* MBeanInfo} {@link Descriptor}.</p>
|
||||
*
|
||||
* <p>The contents of the <code>MBeanInfo</code> for a Dynamic MBean
|
||||
* <p>The contents of the {@code MBeanInfo} for a Dynamic MBean
|
||||
* are determined by its {@link DynamicMBean#getMBeanInfo
|
||||
* getMBeanInfo()} method. This includes Open MBeans and Model
|
||||
* MBeans, which are kinds of Dynamic MBeans.</p>
|
||||
*
|
||||
* <p>The contents of the <code>MBeanInfo</code> for a Standard MBean
|
||||
* <p>The contents of the {@code MBeanInfo} for a Standard MBean
|
||||
* are determined by the MBean server as follows:</p>
|
||||
*
|
||||
* <ul>
|
||||
@ -96,7 +96,7 @@ import static javax.management.ImmutableDescriptor.nonNullDescriptor;
|
||||
* <p>The description returned by {@link #getDescription()} and the
|
||||
* descriptions of the contained attributes and operations are not specified.</p>
|
||||
*
|
||||
* <p>The remaining details of the <code>MBeanInfo</code> for a
|
||||
* <p>The remaining details of the {@code MBeanInfo} for a
|
||||
* Standard MBean are not specified. This includes the description of
|
||||
* any contained constructors, and notifications; the names
|
||||
* of parameters to constructors and operations; and the descriptions of
|
||||
@ -161,10 +161,10 @@ public class MBeanInfo implements Cloneable, Serializable, DescriptorRead {
|
||||
private final transient boolean arrayGettersSafe;
|
||||
|
||||
/**
|
||||
* Constructs an <CODE>MBeanInfo</CODE>.
|
||||
* Constructs an {@code MBeanInfo}.
|
||||
*
|
||||
* @param className The name of the Java class of the MBean described
|
||||
* by this <CODE>MBeanInfo</CODE>. This value may be any
|
||||
* by this {@code MBeanInfo}. This value may be any
|
||||
* syntactically legal Java class name. It does not have to be a
|
||||
* Java class known to the MBean server or to the MBean's
|
||||
* ClassLoader. If it is a Java class known to the MBean's
|
||||
@ -195,10 +195,10 @@ public class MBeanInfo implements Cloneable, Serializable, DescriptorRead {
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs an <CODE>MBeanInfo</CODE>.
|
||||
* Constructs an {@code MBeanInfo}.
|
||||
*
|
||||
* @param className The name of the Java class of the MBean described
|
||||
* by this <CODE>MBeanInfo</CODE>. This value may be any
|
||||
* by this {@code MBeanInfo}. This value may be any
|
||||
* syntactically legal Java class name. It does not have to be a
|
||||
* Java class known to the MBean server or to the MBean's
|
||||
* ClassLoader. If it is a Java class known to the MBean's
|
||||
@ -260,9 +260,9 @@ public class MBeanInfo implements Cloneable, Serializable, DescriptorRead {
|
||||
|
||||
/**
|
||||
* <p>Returns a shallow clone of this instance.
|
||||
* The clone is obtained by simply calling <tt>super.clone()</tt>,
|
||||
* The clone is obtained by simply calling {@code super.clone()},
|
||||
* thus calling the default native shallow cloning mechanism
|
||||
* implemented by <tt>Object.clone()</tt>.
|
||||
* implemented by {@code Object.clone()}.
|
||||
* No deeper cloning of any internal field is made.</p>
|
||||
*
|
||||
* <p>Since this class is immutable, the clone method is chiefly of
|
||||
@ -281,7 +281,7 @@ public class MBeanInfo implements Cloneable, Serializable, DescriptorRead {
|
||||
|
||||
/**
|
||||
* Returns the name of the Java class of the MBean described by
|
||||
* this <CODE>MBeanInfo</CODE>.
|
||||
* this {@code MBeanInfo}.
|
||||
*
|
||||
* @return the class name.
|
||||
*/
|
||||
@ -300,14 +300,14 @@ public class MBeanInfo implements Cloneable, Serializable, DescriptorRead {
|
||||
|
||||
/**
|
||||
* Returns the list of attributes exposed for management.
|
||||
* Each attribute is described by an <CODE>MBeanAttributeInfo</CODE> object.
|
||||
* Each attribute is described by an {@code MBeanAttributeInfo} 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 <CODE>MBeanAttributeInfo</CODE> objects
|
||||
* but that each referenced <CODE>MBeanAttributeInfo</CODE> object is not copied.
|
||||
* references to the {@code MBeanAttributeInfo} objects
|
||||
* but that each referenced {@code MBeanAttributeInfo} object is not copied.
|
||||
*
|
||||
* @return An array of <CODE>MBeanAttributeInfo</CODE> objects.
|
||||
* @return An array of {@code MBeanAttributeInfo} objects.
|
||||
*/
|
||||
public MBeanAttributeInfo[] getAttributes() {
|
||||
MBeanAttributeInfo[] as = nonNullAttributes();
|
||||
@ -342,14 +342,14 @@ public class MBeanInfo implements Cloneable, Serializable, DescriptorRead {
|
||||
|
||||
/**
|
||||
* Returns the list of operations of the MBean.
|
||||
* Each operation is described by an <CODE>MBeanOperationInfo</CODE> object.
|
||||
* Each operation is described by an {@code MBeanOperationInfo} 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 <CODE>MBeanOperationInfo</CODE> objects
|
||||
* but that each referenced <CODE>MBeanOperationInfo</CODE> object is not copied.
|
||||
* references to the {@code MBeanOperationInfo} objects
|
||||
* but that each referenced {@code MBeanOperationInfo} object is not copied.
|
||||
*
|
||||
* @return An array of <CODE>MBeanOperationInfo</CODE> objects.
|
||||
* @return An array of {@code MBeanOperationInfo} objects.
|
||||
*/
|
||||
public MBeanOperationInfo[] getOperations() {
|
||||
MBeanOperationInfo[] os = nonNullOperations();
|
||||
@ -374,12 +374,12 @@ public class MBeanInfo implements Cloneable, Serializable, DescriptorRead {
|
||||
/**
|
||||
* <p>Returns the list of the public constructors of the MBean.
|
||||
* Each constructor is described by an
|
||||
* <CODE>MBeanConstructorInfo</CODE> object.</p>
|
||||
* {@code MBeanConstructorInfo} object.</p>
|
||||
*
|
||||
* <p>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 <CODE>MBeanConstructorInfo</CODE> objects but
|
||||
* that each referenced <CODE>MBeanConstructorInfo</CODE> object
|
||||
* references to the {@code MBeanConstructorInfo} objects but
|
||||
* that each referenced {@code MBeanConstructorInfo} object
|
||||
* is not copied.</p>
|
||||
*
|
||||
* <p>The returned list is not necessarily exhaustive. That is,
|
||||
@ -388,7 +388,7 @@ public class MBeanInfo implements Cloneable, Serializable, DescriptorRead {
|
||||
* instance of this MBean's class using that constructor, even
|
||||
* though it is not listed here.</p>
|
||||
*
|
||||
* @return An array of <CODE>MBeanConstructorInfo</CODE> objects.
|
||||
* @return An array of {@code MBeanConstructorInfo} objects.
|
||||
*/
|
||||
public MBeanConstructorInfo[] getConstructors() {
|
||||
MBeanConstructorInfo[] cs = nonNullConstructors();
|
||||
@ -412,14 +412,14 @@ public class MBeanInfo implements Cloneable, Serializable, DescriptorRead {
|
||||
|
||||
/**
|
||||
* Returns the list of the notifications emitted by the MBean.
|
||||
* Each notification is described by an <CODE>MBeanNotificationInfo</CODE> object.
|
||||
* Each notification is described by an {@code MBeanNotificationInfo} 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 <CODE>MBeanNotificationInfo</CODE> objects
|
||||
* but that each referenced <CODE>MBeanNotificationInfo</CODE> object is not copied.
|
||||
* references to the {@code MBeanNotificationInfo} objects
|
||||
* but that each referenced {@code MBeanNotificationInfo} object is not copied.
|
||||
*
|
||||
* @return An array of <CODE>MBeanNotificationInfo</CODE> objects.
|
||||
* @return An array of {@code MBeanNotificationInfo} objects.
|
||||
*/
|
||||
public MBeanNotificationInfo[] getNotifications() {
|
||||
MBeanNotificationInfo[] ns = nonNullNotifications();
|
||||
@ -482,7 +482,7 @@ public class MBeanInfo implements Cloneable, Serializable, DescriptorRead {
|
||||
*
|
||||
* @param o the object to compare to.
|
||||
*
|
||||
* @return true if and only if <code>o</code> is an MBeanInfo that is equal
|
||||
* @return true if and only if {@code o} is an MBeanInfo that is equal
|
||||
* to this one according to the rules above.
|
||||
*/
|
||||
@Override
|
||||
@ -534,12 +534,12 @@ public class MBeanInfo implements Cloneable, Serializable, DescriptorRead {
|
||||
new WeakHashMap<Class<?>, Boolean>();
|
||||
|
||||
/**
|
||||
* Return true if <code>subclass</code> is known to preserve the
|
||||
* immutability of <code>immutableClass</code>. The class
|
||||
* <code>immutableClass</code> is a reference class that is known
|
||||
* to be immutable. The subclass <code>subclass</code> is
|
||||
* Return true if {@code subclass} is known to preserve the
|
||||
* immutability of {@code immutableClass}. The class
|
||||
* {@code immutableClass} is a reference class that is known
|
||||
* to be immutable. The subclass {@code subclass} is
|
||||
* considered immutable if it does not override any public method
|
||||
* of <code>immutableClass</code> whose name begins with "get".
|
||||
* of {@code immutableClass} whose name begins with "get".
|
||||
* This is obviously not an infallible test for immutability,
|
||||
* but it works for the public interfaces of the MBean*Info classes.
|
||||
*/
|
||||
|
@ -32,29 +32,29 @@ import java.util.Arrays;
|
||||
import java.util.Objects;
|
||||
|
||||
/**
|
||||
* <p>The <CODE>MBeanNotificationInfo</CODE> class is used to describe the
|
||||
* <p>The {@code MBeanNotificationInfo} class is used to describe the
|
||||
* characteristics of the different notification instances
|
||||
* emitted by an MBean, for a given Java class of notification.
|
||||
* If an MBean emits notifications that can be instances of different Java classes,
|
||||
* then the metadata for that MBean should provide an <CODE>MBeanNotificationInfo</CODE>
|
||||
* then the metadata for that MBean should provide an {@code MBeanNotificationInfo}
|
||||
* object for each of these notification Java classes.</p>
|
||||
*
|
||||
* <p>Instances of this class are immutable. Subclasses may be
|
||||
* mutable but this is not recommended.</p>
|
||||
*
|
||||
* <p>This class extends <CODE>javax.management.MBeanFeatureInfo</CODE>
|
||||
* and thus provides <CODE>name</CODE> and <CODE>description</CODE> fields.
|
||||
* The <CODE>name</CODE> field should be the fully qualified Java class name of
|
||||
* <p>This class extends {@code javax.management.MBeanFeatureInfo}
|
||||
* and thus provides {@code name} and {@code description} fields.
|
||||
* The {@code name} field should be the fully qualified Java class name of
|
||||
* the notification objects described by this class.</p>
|
||||
*
|
||||
* <p>The <CODE>getNotifTypes</CODE> method returns an array of
|
||||
* <p>The {@code getNotifTypes} method returns an array of
|
||||
* strings containing the notification types that the MBean may
|
||||
* emit. The notification type is a dot-notation string which
|
||||
* describes what the emitted notification is about, not the Java
|
||||
* class of the notification. A single generic notification class can
|
||||
* be used to send notifications of several types. All of these types
|
||||
* are returned in the string array result of the
|
||||
* <CODE>getNotifTypes</CODE> method.
|
||||
* {@code getNotifTypes} method.
|
||||
*
|
||||
* @since 1.5
|
||||
*/
|
||||
@ -77,7 +77,7 @@ public class MBeanNotificationInfo extends MBeanFeatureInfo implements Cloneable
|
||||
private final transient boolean arrayGettersSafe;
|
||||
|
||||
/**
|
||||
* Constructs an <CODE>MBeanNotificationInfo</CODE> object.
|
||||
* Constructs an {@code MBeanNotificationInfo} object.
|
||||
*
|
||||
* @param notifTypes The array of strings (in dot notation)
|
||||
* containing the notification types that the MBean may emit.
|
||||
@ -93,7 +93,7 @@ public class MBeanNotificationInfo extends MBeanFeatureInfo implements Cloneable
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs an <CODE>MBeanNotificationInfo</CODE> object.
|
||||
* Constructs an {@code MBeanNotificationInfo} object.
|
||||
*
|
||||
* @param notifTypes The array of strings (in dot notation)
|
||||
* containing the notification types that the MBean may emit.
|
||||
@ -128,9 +128,9 @@ public class MBeanNotificationInfo extends MBeanFeatureInfo implements Cloneable
|
||||
|
||||
/**
|
||||
* Returns a shallow clone of this instance.
|
||||
* The clone is obtained by simply calling <tt>super.clone()</tt>,
|
||||
* The clone is obtained by simply calling {@code super.clone()},
|
||||
* thus calling the default native shallow cloning mechanism
|
||||
* implemented by <tt>Object.clone()</tt>.
|
||||
* implemented by {@code Object.clone()}.
|
||||
* No deeper cloning of any internal field is made.
|
||||
*/
|
||||
public Object clone () {
|
||||
@ -179,7 +179,7 @@ public class MBeanNotificationInfo extends MBeanFeatureInfo implements Cloneable
|
||||
*
|
||||
* @param o the object to compare to.
|
||||
*
|
||||
* @return true if and only if <code>o</code> is an MBeanNotificationInfo
|
||||
* @return true if and only if {@code o} is an MBeanNotificationInfo
|
||||
* such that its {@link #getName()}, {@link #getDescription()},
|
||||
* {@link #getDescriptor()},
|
||||
* and {@link #getNotifTypes()} values are equal (not necessarily
|
||||
|
@ -83,10 +83,7 @@ public class MBeanOperationInfo extends MBeanFeatureInfo implements Cloneable {
|
||||
|
||||
/**
|
||||
* @serial The impact of the method, one of
|
||||
* <CODE>INFO</CODE>,
|
||||
* <CODE>ACTION</CODE>,
|
||||
* <CODE>ACTION_INFO</CODE>,
|
||||
* <CODE>UNKNOWN</CODE>
|
||||
* {@code INFO, ACTION, ACTION_INFO, UNKNOWN}.
|
||||
*/
|
||||
private final int impact;
|
||||
|
||||
@ -95,12 +92,12 @@ public class MBeanOperationInfo extends MBeanFeatureInfo implements Cloneable {
|
||||
|
||||
|
||||
/**
|
||||
* Constructs an <CODE>MBeanOperationInfo</CODE> object. The
|
||||
* Constructs an {@code MBeanOperationInfo} object. The
|
||||
* {@link Descriptor} of the constructed object will include
|
||||
* fields contributed by any annotations on the {@code Method}
|
||||
* object that contain the {@link DescriptorKey} meta-annotation.
|
||||
*
|
||||
* @param method The <CODE>java.lang.reflect.Method</CODE> object
|
||||
* @param method The {@code java.lang.reflect.Method} object
|
||||
* describing the MBean operation.
|
||||
* @param description A human readable description of the operation.
|
||||
*/
|
||||
@ -114,11 +111,11 @@ public class MBeanOperationInfo extends MBeanFeatureInfo implements Cloneable {
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs an <CODE>MBeanOperationInfo</CODE> object.
|
||||
* Constructs an {@code MBeanOperationInfo} object.
|
||||
*
|
||||
* @param name The name of the method.
|
||||
* @param description A human readable description of the operation.
|
||||
* @param signature <CODE>MBeanParameterInfo</CODE> objects
|
||||
* @param signature {@code MBeanParameterInfo} objects
|
||||
* describing the parameters(arguments) of the method. This may be
|
||||
* null with the same effect as a zero-length array.
|
||||
* @param type The type of the method's return value.
|
||||
@ -135,11 +132,11 @@ public class MBeanOperationInfo extends MBeanFeatureInfo implements Cloneable {
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs an <CODE>MBeanOperationInfo</CODE> object.
|
||||
* Constructs an {@code MBeanOperationInfo} object.
|
||||
*
|
||||
* @param name The name of the method.
|
||||
* @param description A human readable description of the operation.
|
||||
* @param signature <CODE>MBeanParameterInfo</CODE> objects
|
||||
* @param signature {@code MBeanParameterInfo} objects
|
||||
* describing the parameters(arguments) of the method. This may be
|
||||
* null with the same effect as a zero-length array.
|
||||
* @param type The type of the method's return value.
|
||||
@ -174,9 +171,9 @@ public class MBeanOperationInfo extends MBeanFeatureInfo implements Cloneable {
|
||||
|
||||
/**
|
||||
* <p>Returns a shallow clone of this instance.
|
||||
* The clone is obtained by simply calling <tt>super.clone()</tt>,
|
||||
* The clone is obtained by simply calling {@code super.clone()},
|
||||
* thus calling the default native shallow cloning mechanism
|
||||
* implemented by <tt>Object.clone()</tt>.
|
||||
* implemented by {@code Object.clone()}.
|
||||
* No deeper cloning of any internal field is made.</p>
|
||||
*
|
||||
* <p>Since this class is immutable, cloning is chiefly of interest
|
||||
@ -203,16 +200,16 @@ public class MBeanOperationInfo extends MBeanFeatureInfo implements Cloneable {
|
||||
|
||||
/**
|
||||
* <p>Returns the list of parameters for this operation. Each
|
||||
* parameter is described by an <CODE>MBeanParameterInfo</CODE>
|
||||
* parameter is described by an {@code MBeanParameterInfo}
|
||||
* object.</p>
|
||||
*
|
||||
* <p>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 <CODE>MBeanParameterInfo</CODE> objects but
|
||||
* that each referenced <CODE>MBeanParameterInfo</CODE> object is
|
||||
* references to the {@code MBeanParameterInfo} objects but
|
||||
* that each referenced {@code MBeanParameterInfo} object is
|
||||
* not copied.</p>
|
||||
*
|
||||
* @return An array of <CODE>MBeanParameterInfo</CODE> objects.
|
||||
* @return An array of {@code MBeanParameterInfo} objects.
|
||||
*/
|
||||
public MBeanParameterInfo[] getSignature() {
|
||||
// If MBeanOperationInfo was created in our implementation,
|
||||
@ -247,7 +244,7 @@ public class MBeanOperationInfo extends MBeanFeatureInfo implements Cloneable {
|
||||
|
||||
/**
|
||||
* Returns the impact of the method, one of
|
||||
* <CODE>INFO</CODE>, <CODE>ACTION</CODE>, <CODE>ACTION_INFO</CODE>, <CODE>UNKNOWN</CODE>.
|
||||
* {@code INFO, ACTION, ACTION_INFO, UNKNOWN}.
|
||||
*
|
||||
* @return the impact code.
|
||||
*/
|
||||
@ -280,7 +277,7 @@ public class MBeanOperationInfo extends MBeanFeatureInfo implements Cloneable {
|
||||
*
|
||||
* @param o the object to compare to.
|
||||
*
|
||||
* @return true if and only if <code>o</code> is an MBeanOperationInfo such
|
||||
* @return true if and only if {@code o} is an MBeanOperationInfo such
|
||||
* that its {@link #getName()}, {@link #getReturnType()}, {@link
|
||||
* #getDescription()}, {@link #getImpact()}, {@link #getDescriptor()}
|
||||
* and {@link #getSignature()} values are equal (not necessarily identical)
|
||||
|
@ -50,7 +50,7 @@ public class MBeanParameterInfo extends MBeanFeatureInfo implements Cloneable {
|
||||
|
||||
|
||||
/**
|
||||
* Constructs an <CODE>MBeanParameterInfo</CODE> object.
|
||||
* Constructs an {@code MBeanParameterInfo} object.
|
||||
*
|
||||
* @param name The name of the data
|
||||
* @param type The type or class name of the data
|
||||
@ -63,7 +63,7 @@ public class MBeanParameterInfo extends MBeanFeatureInfo implements Cloneable {
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs an <CODE>MBeanParameterInfo</CODE> object.
|
||||
* Constructs an {@code MBeanParameterInfo} object.
|
||||
*
|
||||
* @param name The name of the data
|
||||
* @param type The type or class name of the data
|
||||
@ -85,9 +85,9 @@ public class MBeanParameterInfo extends MBeanFeatureInfo implements Cloneable {
|
||||
|
||||
/**
|
||||
* <p>Returns a shallow clone of this instance.
|
||||
* The clone is obtained by simply calling <tt>super.clone()</tt>,
|
||||
* The clone is obtained by simply calling {@code super.clone()},
|
||||
* thus calling the default native shallow cloning mechanism
|
||||
* implemented by <tt>Object.clone()</tt>.
|
||||
* implemented by {@code Object.clone()}.
|
||||
* No deeper cloning of any internal field is made.</p>
|
||||
*
|
||||
* <p>Since this class is immutable, cloning is chiefly of
|
||||
@ -126,7 +126,7 @@ public class MBeanParameterInfo extends MBeanFeatureInfo implements Cloneable {
|
||||
*
|
||||
* @param o the object to compare to.
|
||||
*
|
||||
* @return true if and only if <code>o</code> is an MBeanParameterInfo such
|
||||
* @return true if and only if {@code o} is an MBeanParameterInfo such
|
||||
* that its {@link #getName()}, {@link #getType()},
|
||||
* {@link #getDescriptor()}, and {@link
|
||||
* #getDescription()} values are equal (not necessarily identical)
|
||||
|
@ -41,20 +41,20 @@ questions.
|
||||
<p id="complex">The value being monitored can be a simple value
|
||||
contained within a complex type. For example, the {@link
|
||||
java.lang.management.MemoryMXBean MemoryMXBean} defined in
|
||||
<tt>java.lang.management</tt> has an attribute
|
||||
<tt>HeapMemoryUsage</tt> of type {@link
|
||||
{@code java.lang.management} has an attribute
|
||||
{@code HeapMemoryUsage} of type {@link
|
||||
java.lang.management.MemoryUsage MemoryUsage}. To monitor the
|
||||
amount of <i>used</i> memory, described by the <tt>used</tt>
|
||||
property of <tt>MemoryUsage</tt>, you could monitor
|
||||
"<tt>HeapMemoryUsage.used</tt>". That string would be the
|
||||
amount of <i>used</i> memory, described by the {@code used}
|
||||
property of {@code MemoryUsage}, you could monitor
|
||||
"{@code HeapMemoryUsage.used}". That string would be the
|
||||
argument to {@link
|
||||
javax.management.monitor.MonitorMBean#setObservedAttribute(String)
|
||||
setObservedAttribute}.</p>
|
||||
|
||||
<p>The rules used to interpret an <tt>ObservedAttribute</tt> like
|
||||
<tt>"HeapMemoryUsage.used"</tt> are as follows. Suppose the string is
|
||||
<i>A.e</i> (so <i>A</i> would be <tt>"HeapMemoryUsage"</tt> and <i>e</i>
|
||||
would be <tt>"used"</tt> in the example).</p>
|
||||
<p>The rules used to interpret an {@code ObservedAttribute} like
|
||||
{@code "HeapMemoryUsage.used"} are as follows. Suppose the string is
|
||||
<i>A.e</i> (so <i>A</i> would be {@code "HeapMemoryUsage"} and <i>e</i>
|
||||
would be {@code "used"} in the example).</p>
|
||||
|
||||
<p>First the value of the attribute <i>A</i> is obtained. Call it
|
||||
<i>v</i>. A value <i>x</i> is extracted from <i>v</i> as follows:</p>
|
||||
@ -65,49 +65,49 @@ questions.
|
||||
CompositeData} and if <i>v</i>.{@link
|
||||
javax.management.openmbean.CompositeData#get(String) get}(<i>e</i>)
|
||||
returns a value then <i>x</i> is that value.</li>
|
||||
<li>If <i>v</i> is an array and <i>e</i> is the string <tt>"length"</tt>
|
||||
<li>If <i>v</i> is an array and <i>e</i> is the string {@code "length"}
|
||||
then <i>x</i> is the length of the array.</li>
|
||||
|
||||
<li>If the above rules do not produce a value, and if introspection, as
|
||||
if by calling {@link java.beans.Introspector#getBeanInfo(Class)
|
||||
Introspector.getBeanInfo}, for the class of <i>v</i>
|
||||
(<i>v</i>.<tt>getClass()</tt>) identifies a property with the name
|
||||
(<i>v</i>.{@code getClass()}) identifies a property with the name
|
||||
<i>e</i>, then <i>x</i> is the result of reading the property value. </li>
|
||||
|
||||
</ul>
|
||||
|
||||
<p>The third rule means for example that if the attribute
|
||||
<tt>HeapMemoryUsage</tt> is a <tt>MemoryUsage</tt>, monitoring
|
||||
<tt>"HeapMemoryUsage.used"</tt> will obtain the observed value by
|
||||
calling <tt>MemoryUsage.getUsed()</tt>.</p>
|
||||
{@code HeapMemoryUsage} is a {@code MemoryUsage}, monitoring
|
||||
{@code "HeapMemoryUsage.used"} will obtain the observed value by
|
||||
calling {@code MemoryUsage.getUsed()}.</p>
|
||||
|
||||
<p>If the <tt>ObservedAttribute</tt> contains more than one period,
|
||||
for example <tt>"ConnectionPool.connectionStats.length"</tt>, then the
|
||||
<p>If the {@code ObservedAttribute} contains more than one period,
|
||||
for example {@code "ConnectionPool.connectionStats.length"}, then the
|
||||
above rules are applied iteratively. Here, <i>v</i> would initially be
|
||||
the value of the attribute <tt>ConnectionPool</tt>, and <i>x</i> would
|
||||
the value of the attribute {@code ConnectionPool}, and <i>x</i> would
|
||||
be derived by applying the above rules with <i>e</i> equal to
|
||||
<tt>"connectionStats"</tt>. Then <i>v</i> would be set to this <i>x</i>
|
||||
{@code "connectionStats"}. Then <i>v</i> would be set to this <i>x</i>
|
||||
and a new <i>x</i> derived by applying the rules again with <i>e</i>
|
||||
equal to <tt>"length"</tt>.</p>
|
||||
equal to {@code "length"}.</p>
|
||||
|
||||
<p>Although it is recommended that attribute names be valid Java
|
||||
identifiers, it is possible for an attribute to be called
|
||||
<tt>HeapMemoryUsage.used</tt>. This means that an
|
||||
<tt>ObservedAttribute</tt> that is <tt>HeapMemoryUsage.used</tt>
|
||||
{@code HeapMemoryUsage.used}. This means that an
|
||||
{@code ObservedAttribute} that is {@code HeapMemoryUsage.used}
|
||||
could mean that the value to observe is either an attribute of that
|
||||
name, or the property <tt>used</tt> within an attribute called
|
||||
<tt>HeapMemoryUsage</tt>. So for compatibility reasons, when the
|
||||
<tt>ObservedAttribute</tt> contains a period (<tt>.</tt>), the monitor
|
||||
name, or the property {@code used} within an attribute called
|
||||
{@code HeapMemoryUsage}. So for compatibility reasons, when the
|
||||
{@code ObservedAttribute} contains a period ({@code .}), the monitor
|
||||
will check whether an attribute exists whose name is the full
|
||||
<tt>ObservedAttribute</tt> string (<tt>HeapMemoryUsage.used</tt> in the
|
||||
{@code ObservedAttribute} string ({@code HeapMemoryUsage.used} in the
|
||||
example). It does this by calling {@link
|
||||
javax.management.MBeanServer#getMBeanInfo(javax.management.ObjectName)
|
||||
getMBeanInfo} for the observed MBean and looking for a contained {@link
|
||||
javax.management.MBeanAttributeInfo MBeanAttributeInfo} with the given
|
||||
name. If one is found, then that is what is monitored. If more than one
|
||||
MBean is being observed, the behavior is unspecified if some of them have
|
||||
a <tt>HeapMemoryUsage.used</tt> attribute and others do not. An
|
||||
implementation may therefore call <tt>getMBeanInfo</tt> on just one of
|
||||
a {@code HeapMemoryUsage.used} attribute and others do not. An
|
||||
implementation may therefore call {@code getMBeanInfo} on just one of
|
||||
the MBeans in this case. The behavior is also unspecified if the result
|
||||
of the check changes while the monitor is active.</p>
|
||||
|
||||
|
@ -29,7 +29,7 @@ import java.io.ObjectStreamException;
|
||||
import java.lang.reflect.Array;
|
||||
|
||||
/**
|
||||
* The <code>ArrayType</code> class is the <i>open type</i> class whose instances describe
|
||||
* The {@code ArrayType} class is the <i>open type</i> class whose instances describe
|
||||
* all <i>open data</i> values which are n-dimensional arrays of <i>open data</i> values.
|
||||
* <p>
|
||||
* Examples of valid {@code ArrayType} instances are:
|
||||
@ -222,22 +222,31 @@ public class ArrayType<T> extends OpenType<T> {
|
||||
/* *** Constructor *** */
|
||||
|
||||
/**
|
||||
* Constructs an <tt>ArrayType</tt> instance describing <i>open data</i> values which are
|
||||
* arrays with dimension <var>dimension</var> of elements whose <i>open type</i> is <var>elementType</var>.
|
||||
* Constructs an {@code ArrayType} instance describing <i>open data</i> values which are
|
||||
* arrays with dimension <var>dimension</var> of elements
|
||||
* whose <i>open type</i> is <var>elementType</var>.
|
||||
* <p>
|
||||
* When invoked on an <tt>ArrayType</tt> instance, the {@link OpenType#getClassName() getClassName} method
|
||||
* returns the class name of the array instances it describes (following the rules defined by the
|
||||
* {@link Class#getName() getName} method of <code>java.lang.Class</code>), not the class name of the array elements
|
||||
* (which is returned by a call to <tt>getElementOpenType().getClassName()</tt>).
|
||||
* When invoked on an {@code ArrayType} instance,
|
||||
* the {@link OpenType#getClassName() getClassName} method
|
||||
* returns the class name of the array instances it describes
|
||||
* (following the rules defined by the
|
||||
* {@link Class#getName() getName} method of {@code java.lang.Class}),
|
||||
* not the class name of the array elements
|
||||
* (which is returned by a call to {@code getElementOpenType().getClassName()}).
|
||||
* <p>
|
||||
* The internal field corresponding to the type name of this <code>ArrayType</code> instance is also set to
|
||||
* The internal field corresponding to the type name of this
|
||||
* {@code ArrayType} instance is also set to
|
||||
* the class name of the array instances it describes.
|
||||
* In other words, the methods <code>getClassName</code> and <code>getTypeName</code> return the same string value.
|
||||
* The internal field corresponding to the description of this <code>ArrayType</code> instance is set to a string value
|
||||
* In other words, the methods {@code getClassName} and
|
||||
* {@code getTypeName} return the same string value.
|
||||
* The internal field corresponding to the description of this
|
||||
* {@code ArrayType} instance is set to a string value
|
||||
* which follows the following template:
|
||||
* <ul>
|
||||
* <li>if non-primitive array: <tt><i><dimension></i>-dimension array of <i><element_class_name></i></tt></li>
|
||||
* <li>if primitive array: <tt><i><dimension></i>-dimension array of <i><primitive_type_of_the_element_class_name></i></tt></li>
|
||||
* <li>if non-primitive array: <code><i><dimension></i>-dimension array
|
||||
* of <i><element_class_name></i></code></li>
|
||||
* <li>if primitive array: <code><i><dimension></i>-dimension array
|
||||
* of <i><primitive_type_of_the_element_class_name></i></code></li>
|
||||
* </ul>
|
||||
* <p>
|
||||
* As an example, the following piece of code:
|
||||
@ -267,16 +276,16 @@ public class ArrayType<T> extends OpenType<T> {
|
||||
* System.out.println("array type description = " + t3.getDescription());
|
||||
* }</pre>
|
||||
*
|
||||
* @param dimension the dimension of arrays described by this <tt>ArrayType</tt> instance;
|
||||
* @param dimension the dimension of arrays described by this {@code ArrayType} instance;
|
||||
* must be greater than or equal to 1.
|
||||
*
|
||||
* @param elementType the <i>open type</i> of element values contained
|
||||
* in the arrays described by this <tt>ArrayType</tt>
|
||||
* in the arrays described by this {@code ArrayType}
|
||||
* instance; must be an instance of either
|
||||
* <tt>SimpleType</tt>, <tt>CompositeType</tt>,
|
||||
* <tt>TabularType</tt> or another <tt>ArrayType</tt>
|
||||
* with a <tt>SimpleType</tt>, <tt>CompositeType</tt>
|
||||
* or <tt>TabularType</tt> as its <tt>elementType</tt>.
|
||||
* {@code SimpleType}, {@code CompositeType},
|
||||
* {@code TabularType} or another {@code ArrayType}
|
||||
* with a {@code SimpleType}, {@code CompositeType}
|
||||
* or {@code TabularType} as its {@code elementType}.
|
||||
*
|
||||
* @throws IllegalArgumentException if {@code dimension} is not a positive
|
||||
* integer.
|
||||
@ -318,19 +327,27 @@ public class ArrayType<T> extends OpenType<T> {
|
||||
* returns the {@link SimpleType} corresponding to the wrapper
|
||||
* type of the primitive type of the array.
|
||||
* <p>
|
||||
* When invoked on an <tt>ArrayType</tt> instance, the {@link OpenType#getClassName() getClassName} method
|
||||
* returns the class name of the array instances it describes (following the rules defined by the
|
||||
* {@link Class#getName() getName} method of <code>java.lang.Class</code>), not the class name of the array elements
|
||||
* (which is returned by a call to <tt>getElementOpenType().getClassName()</tt>).
|
||||
* When invoked on an {@code ArrayType} instance,
|
||||
* the {@link OpenType#getClassName() getClassName} method
|
||||
* returns the class name of the array instances it describes
|
||||
* (following the rules defined by the
|
||||
* {@link Class#getName() getName} method of {@code java.lang.Class}),
|
||||
* not the class name of the array elements
|
||||
* (which is returned by a call to {@code getElementOpenType().getClassName()}).
|
||||
* <p>
|
||||
* The internal field corresponding to the type name of this <code>ArrayType</code> instance is also set to
|
||||
* The internal field corresponding to the type name of this
|
||||
* {@code ArrayType} instance is also set to
|
||||
* the class name of the array instances it describes.
|
||||
* In other words, the methods <code>getClassName</code> and <code>getTypeName</code> return the same string value.
|
||||
* The internal field corresponding to the description of this <code>ArrayType</code> instance is set to a string value
|
||||
* In other words, the methods {@code getClassName} and
|
||||
* {@code getTypeName} return the same string value.
|
||||
* The internal field corresponding to the description
|
||||
* of this {@code ArrayType} instance is set to a string value
|
||||
* which follows the following template:
|
||||
* <ul>
|
||||
* <li>if non-primitive array: <tt>1-dimension array of <i><element_class_name></i></tt></li>
|
||||
* <li>if primitive array: <tt>1-dimension array of <i><primitive_type_of_the_element_class_name></i></tt></li>
|
||||
* <li>if non-primitive array: <code>1-dimension array
|
||||
* of <i><element_class_name></i></code></li>
|
||||
* <li>if primitive array: <code>1-dimension array
|
||||
* of <i><primitive_type_of_the_element_class_name></i></code></li>
|
||||
* </ul>
|
||||
* <p>
|
||||
* As an example, the following piece of code:
|
||||
@ -483,7 +500,7 @@ public class ArrayType<T> extends OpenType<T> {
|
||||
/* *** ArrayType specific information methods *** */
|
||||
|
||||
/**
|
||||
* Returns the dimension of arrays described by this <tt>ArrayType</tt> instance.
|
||||
* Returns the dimension of arrays described by this {@code ArrayType} instance.
|
||||
*
|
||||
* @return the dimension.
|
||||
*/
|
||||
@ -493,7 +510,8 @@ public class ArrayType<T> extends OpenType<T> {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the <i>open type</i> of element values contained in the arrays described by this <tt>ArrayType</tt> instance.
|
||||
* Returns the <i>open type</i> of element values contained
|
||||
* in the arrays described by this {@code ArrayType} instance.
|
||||
*
|
||||
* @return the element type.
|
||||
*/
|
||||
@ -503,8 +521,8 @@ public class ArrayType<T> extends OpenType<T> {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns <code>true</code> if the open data values this open
|
||||
* type describes are primitive arrays, <code>false</code> otherwise.
|
||||
* Returns {@code true} if the open data values this open
|
||||
* type describes are primitive arrays, {@code false} otherwise.
|
||||
*
|
||||
* @return true if this is a primitive array type.
|
||||
*
|
||||
@ -516,32 +534,32 @@ public class ArrayType<T> extends OpenType<T> {
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests whether <var>obj</var> is a value for this <code>ArrayType</code>
|
||||
* Tests whether <var>obj</var> is a value for this {@code ArrayType}
|
||||
* instance.
|
||||
* <p>
|
||||
* This method returns <code>true</code> if and only if <var>obj</var>
|
||||
* This method returns {@code true} if and only if <var>obj</var>
|
||||
* is not null, <var>obj</var> is an array and any one of the following
|
||||
* is <tt>true</tt>:
|
||||
* is {@code true}:
|
||||
*
|
||||
* <ul>
|
||||
* <li>if this <code>ArrayType</code> instance describes an array of
|
||||
* <tt>SimpleType</tt> elements or their corresponding primitive types,
|
||||
* <li>if this {@code ArrayType} instance describes an array of
|
||||
* {@code SimpleType} elements or their corresponding primitive types,
|
||||
* <var>obj</var>'s class name is the same as the className field defined
|
||||
* for this <code>ArrayType</code> instance (i.e. the class name returned
|
||||
* for this {@code ArrayType} instance (i.e. the class name returned
|
||||
* by the {@link OpenType#getClassName() getClassName} method, which
|
||||
* includes the dimension information),<br> </li>
|
||||
* <li>if this <code>ArrayType</code> instance describes an array of
|
||||
* <li>if this {@code ArrayType} instance describes an array of
|
||||
* classes implementing the {@code TabularData} interface or the
|
||||
* {@code CompositeData} interface, <var>obj</var> is assignable to
|
||||
* such a declared array, and each element contained in {<var>obj</var>
|
||||
* is either null or a valid value for the element's open type specified
|
||||
* by this <code>ArrayType</code> instance.</li>
|
||||
* by this {@code ArrayType} instance.</li>
|
||||
* </ul>
|
||||
*
|
||||
* @param obj the object to be tested.
|
||||
*
|
||||
* @return <code>true</code> if <var>obj</var> is a value for this
|
||||
* <code>ArrayType</code> instance.
|
||||
* @return {@code true} if <var>obj</var> is a value for this
|
||||
* {@code ArrayType} instance.
|
||||
*/
|
||||
public boolean isValue(Object obj) {
|
||||
|
||||
@ -649,21 +667,21 @@ public class ArrayType<T> extends OpenType<T> {
|
||||
/* *** Methods overriden from class Object *** */
|
||||
|
||||
/**
|
||||
* Compares the specified <code>obj</code> parameter with this
|
||||
* <code>ArrayType</code> instance for equality.
|
||||
* Compares the specified {@code obj} parameter with this
|
||||
* {@code ArrayType} instance for equality.
|
||||
* <p>
|
||||
* Two <code>ArrayType</code> instances are equal if and only if they
|
||||
* Two {@code ArrayType} instances are equal if and only if they
|
||||
* describe array instances which have the same dimension, elements'
|
||||
* open type and primitive array flag.
|
||||
*
|
||||
* @param obj the object to be compared for equality with this
|
||||
* <code>ArrayType</code> instance; if <var>obj</var>
|
||||
* is <code>null</code> or is not an instance of the
|
||||
* class <code>ArrayType</code> this method returns
|
||||
* <code>false</code>.
|
||||
* {@code ArrayType} instance; if <var>obj</var>
|
||||
* is {@code null} or is not an instance of the
|
||||
* class {@code ArrayType} this method returns
|
||||
* {@code false}.
|
||||
*
|
||||
* @return <code>true</code> if the specified object is equal to
|
||||
* this <code>ArrayType</code> instance.
|
||||
* @return {@code true} if the specified object is equal to
|
||||
* this {@code ArrayType} instance.
|
||||
*/
|
||||
public boolean equals(Object obj) {
|
||||
|
||||
@ -697,25 +715,25 @@ public class ArrayType<T> extends OpenType<T> {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the hash code value for this <code>ArrayType</code> instance.
|
||||
* Returns the hash code value for this {@code ArrayType} instance.
|
||||
* <p>
|
||||
* The hash code of an <code>ArrayType</code> instance is the sum of the
|
||||
* hash codes of all the elements of information used in <code>equals</code>
|
||||
* The hash code of an {@code ArrayType} instance is the sum of the
|
||||
* hash codes of all the elements of information used in {@code equals}
|
||||
* comparisons (i.e. dimension, elements' open type and primitive array flag).
|
||||
* The hashcode for a primitive value is the hashcode of the corresponding boxed
|
||||
* object (e.g. the hashcode for <tt>true</tt> is <tt>Boolean.TRUE.hashCode()</tt>).
|
||||
* This ensures that <code> t1.equals(t2) </code> implies that
|
||||
* <code> t1.hashCode()==t2.hashCode() </code> for any two
|
||||
* <code>ArrayType</code> instances <code>t1</code> and <code>t2</code>,
|
||||
* object (e.g. the hashcode for {@code true} is {@code Boolean.TRUE.hashCode()}).
|
||||
* This ensures that {@code t1.equals(t2)} implies that
|
||||
* {@code t1.hashCode()==t2.hashCode()} for any two
|
||||
* {@code ArrayType} instances {@code t1} and {@code t2},
|
||||
* as required by the general contract of the method
|
||||
* {@link Object#hashCode() Object.hashCode()}.
|
||||
* <p>
|
||||
* As <code>ArrayType</code> instances are immutable, the hash
|
||||
* As {@code ArrayType} instances are immutable, the hash
|
||||
* code for this instance is calculated once, on the first call
|
||||
* to <code>hashCode</code>, and then the same value is returned
|
||||
* to {@code hashCode}, and then the same value is returned
|
||||
* for subsequent calls.
|
||||
*
|
||||
* @return the hash code value for this <code>ArrayType</code> instance
|
||||
* @return the hash code value for this {@code ArrayType} instance
|
||||
*/
|
||||
public int hashCode() {
|
||||
|
||||
@ -735,19 +753,19 @@ public class ArrayType<T> extends OpenType<T> {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a string representation of this <code>ArrayType</code> instance.
|
||||
* Returns a string representation of this {@code ArrayType} instance.
|
||||
* <p>
|
||||
* The string representation consists of the name of this class (i.e.
|
||||
* <code>javax.management.openmbean.ArrayType</code>), the type name,
|
||||
* {@code javax.management.openmbean.ArrayType}), the type name,
|
||||
* the dimension, the elements' open type and the primitive array flag
|
||||
* defined for this instance.
|
||||
* <p>
|
||||
* As <code>ArrayType</code> instances are immutable, the
|
||||
* As {@code ArrayType} instances are immutable, the
|
||||
* string representation for this instance is calculated
|
||||
* once, on the first call to <code>toString</code>, and
|
||||
* once, on the first call to {@code toString}, and
|
||||
* then the same value is returned for subsequent calls.
|
||||
*
|
||||
* @return a string representation of this <code>ArrayType</code> instance
|
||||
* @return a string representation of this {@code ArrayType} instance
|
||||
*/
|
||||
public String toString() {
|
||||
|
||||
@ -795,12 +813,12 @@ public class ArrayType<T> extends OpenType<T> {
|
||||
*
|
||||
* @param <E> the Java type that described instances must have
|
||||
* @param elementType the <i>open type</i> of element values contained
|
||||
* in the arrays described by this <tt>ArrayType</tt>
|
||||
* in the arrays described by this {@code ArrayType}
|
||||
* instance; must be an instance of either
|
||||
* <tt>SimpleType</tt>, <tt>CompositeType</tt>,
|
||||
* <tt>TabularType</tt> or another <tt>ArrayType</tt>
|
||||
* with a <tt>SimpleType</tt>, <tt>CompositeType</tt>
|
||||
* or <tt>TabularType</tt> as its <tt>elementType</tt>.
|
||||
* {@code SimpleType}, {@code CompositeType},
|
||||
* {@code TabularType} or another {@code ArrayType}
|
||||
* with a {@code SimpleType}, {@code CompositeType}
|
||||
* or {@code TabularType} as its {@code elementType}.
|
||||
* @return an {@code ArrayType} instance
|
||||
* @throws OpenDataException if <var>elementType's className</var> is not
|
||||
* one of the allowed Java class names for open
|
||||
|
@ -36,7 +36,8 @@ import java.util.Collection;
|
||||
|
||||
|
||||
/**
|
||||
* The <tt>CompositeData</tt> interface specifies the behavior of a specific type of complex <i>open data</i> objects
|
||||
* The {@code CompositeData} interface specifies
|
||||
* the behavior of a specific type of complex <i>open data</i> objects
|
||||
* which represent <i>composite data</i> structures.
|
||||
*
|
||||
*
|
||||
@ -53,55 +54,60 @@ public interface CompositeData {
|
||||
public CompositeType getCompositeType();
|
||||
|
||||
/**
|
||||
* Returns the value of the item whose name is <tt>key</tt>.
|
||||
* Returns the value of the item whose name is {@code key}.
|
||||
*
|
||||
* @param key the name of the item.
|
||||
*
|
||||
* @return the value associated with this key.
|
||||
*
|
||||
* @throws IllegalArgumentException if <tt>key</tt> is a null or empty String.
|
||||
* @throws IllegalArgumentException if {@code key} is a null or empty String.
|
||||
*
|
||||
* @throws InvalidKeyException if <tt>key</tt> is not an existing item name for this <tt>CompositeData</tt> instance.
|
||||
* @throws InvalidKeyException if {@code key} is not an
|
||||
* existing item name for this {@code CompositeData} instance.
|
||||
*/
|
||||
public Object get(String key) ;
|
||||
|
||||
/**
|
||||
* Returns an array of the values of the items whose names are specified by <tt>keys</tt>, in the same order as <tt>keys</tt>.
|
||||
* Returns an array of the values of the items whose names
|
||||
* are specified by {@code keys}, in the same order as {@code keys}.
|
||||
*
|
||||
* @param keys the names of the items.
|
||||
*
|
||||
* @return the values corresponding to the keys.
|
||||
*
|
||||
* @throws IllegalArgumentException if an element in <tt>keys</tt> is a null or empty String.
|
||||
* @throws IllegalArgumentException if an element in {@code keys} is a null or empty String.
|
||||
*
|
||||
* @throws InvalidKeyException if an element in <tt>keys</tt> is not an existing item name for this <tt>CompositeData</tt> instance.
|
||||
* @throws InvalidKeyException if an element in {@code keys}
|
||||
* is not an existing item name for this {@code CompositeData} instance.
|
||||
*/
|
||||
public Object[] getAll(String[] keys) ;
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if and only if this <tt>CompositeData</tt> instance contains
|
||||
* an item whose name is <tt>key</tt>.
|
||||
* If <tt>key</tt> is a null or empty String, this method simply returns false.
|
||||
* Returns {@code true} if and only if this {@code CompositeData} instance contains
|
||||
* an item whose name is {@code key}.
|
||||
* If {@code key} is a null or empty String, this method simply returns false.
|
||||
*
|
||||
* @param key the key to be tested.
|
||||
*
|
||||
* @return true if this <tt>CompositeData</tt> contains the key.
|
||||
* @return true if this {@code CompositeData} contains the key.
|
||||
*/
|
||||
public boolean containsKey(String key) ;
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if and only if this <tt>CompositeData</tt> instance contains an item
|
||||
* whose value is <tt>value</tt>.
|
||||
* Returns {@code true} if and only if this {@code CompositeData} instance contains an item
|
||||
* whose value is {@code value}.
|
||||
*
|
||||
* @param value the value to be tested.
|
||||
*
|
||||
* @return true if this <tt>CompositeData</tt> contains the value.
|
||||
* @return true if this {@code CompositeData} contains the value.
|
||||
*/
|
||||
public boolean containsValue(Object value) ;
|
||||
|
||||
/**
|
||||
* Returns an unmodifiable Collection view of the item values contained in this <tt>CompositeData</tt> instance.
|
||||
* The returned collection's iterator will return the values in the ascending lexicographic order of the corresponding
|
||||
* Returns an unmodifiable Collection view of the item values
|
||||
* contained in this {@code CompositeData} instance.
|
||||
* The returned collection's iterator will return the values
|
||||
* in the ascending lexicographic order of the corresponding
|
||||
* item names.
|
||||
*
|
||||
* @return the values.
|
||||
@ -110,12 +116,12 @@ public interface CompositeData {
|
||||
|
||||
/**
|
||||
* Compares the specified <var>obj</var> parameter with this
|
||||
* <code>CompositeData</code> instance for equality.
|
||||
* {@code CompositeData} instance for equality.
|
||||
* <p>
|
||||
* Returns <tt>true</tt> if and only if all of the following statements are true:
|
||||
* Returns {@code true} if and only if all of the following statements are true:
|
||||
* <ul>
|
||||
* <li><var>obj</var> is non null,</li>
|
||||
* <li><var>obj</var> also implements the <code>CompositeData</code> interface,</li>
|
||||
* <li><var>obj</var> also implements the {@code CompositeData} interface,</li>
|
||||
* <li>their composite types are equal</li>
|
||||
* <li>their contents, i.e. (name, value) pairs are equal. If a value contained in
|
||||
* the content is an array, the value comparison is done as if by calling
|
||||
@ -124,28 +130,28 @@ public interface CompositeData {
|
||||
* {@code Arrays.equals(e1,e2)} for arrays of primitive types</li>
|
||||
* </ul>
|
||||
* <p>
|
||||
* This ensures that this <tt>equals</tt> method works properly for
|
||||
* This ensures that this {@code equals} method works properly for
|
||||
* <var>obj</var> parameters which are different implementations of the
|
||||
* <code>CompositeData</code> interface, with the restrictions mentioned in the
|
||||
* {@code CompositeData} interface, with the restrictions mentioned in the
|
||||
* {@link java.util.Collection#equals(Object) equals}
|
||||
* method of the <tt>java.util.Collection</tt> interface.
|
||||
* method of the {@code java.util.Collection} interface.
|
||||
*
|
||||
* @param obj the object to be compared for equality with this
|
||||
* <code>CompositeData</code> instance.
|
||||
* @return <code>true</code> if the specified object is equal to this
|
||||
* <code>CompositeData</code> instance.
|
||||
* {@code CompositeData} instance.
|
||||
* @return {@code true} if the specified object is equal to this
|
||||
* {@code CompositeData} instance.
|
||||
*/
|
||||
public boolean equals(Object obj) ;
|
||||
|
||||
/**
|
||||
* Returns the hash code value for this <code>CompositeData</code> instance.
|
||||
* Returns the hash code value for this {@code CompositeData} instance.
|
||||
* <p>
|
||||
* The hash code of a <code>CompositeData</code> instance is the sum of the hash codes
|
||||
* of all elements of information used in <code>equals</code> comparisons
|
||||
* The hash code of a {@code CompositeData} instance is the sum of the hash codes
|
||||
* of all elements of information used in {@code equals} comparisons
|
||||
* (ie: its <i>composite type</i> and all the item values).
|
||||
* <p>
|
||||
* This ensures that <code> t1.equals(t2) </code> implies that <code> t1.hashCode()==t2.hashCode() </code>
|
||||
* for any two <code>CompositeData</code> instances <code>t1</code> and <code>t2</code>,
|
||||
* This ensures that {@code t1.equals(t2)} implies that {@code t1.hashCode()==t2.hashCode()}
|
||||
* for any two {@code CompositeData} instances {@code t1} and {@code t2},
|
||||
* as required by the general contract of the method
|
||||
* {@link Object#hashCode() Object.hashCode()}.
|
||||
* <p>
|
||||
@ -156,18 +162,19 @@ public interface CompositeData {
|
||||
* for arrays of object reference types or the appropriate overloading
|
||||
* of {@code Arrays.hashCode(e)} for arrays of primitive types.
|
||||
*
|
||||
* @return the hash code value for this <code>CompositeData</code> instance
|
||||
* @return the hash code value for this {@code CompositeData} instance
|
||||
*/
|
||||
public int hashCode() ;
|
||||
|
||||
/**
|
||||
* Returns a string representation of this <code>CompositeData</code> instance.
|
||||
* Returns a string representation of this {@code CompositeData} instance.
|
||||
* <p>
|
||||
* The string representation consists of the name of the implementing class,
|
||||
* the string representation of the composite type of this instance, and the string representation of the contents
|
||||
* the string representation of the composite type of this instance,
|
||||
* and the string representation of the contents
|
||||
* (ie list the itemName=itemValue mappings).
|
||||
*
|
||||
* @return a string representation of this <code>CompositeData</code> instance
|
||||
* @return a string representation of this {@code CompositeData} instance
|
||||
*/
|
||||
public String toString() ;
|
||||
|
||||
|
@ -45,8 +45,8 @@ import java.util.TreeSet;
|
||||
|
||||
|
||||
/**
|
||||
* The <tt>CompositeDataSupport</tt> class is the <i>open data</i> class which
|
||||
* implements the <tt>CompositeData</tt> interface.
|
||||
* The {@code CompositeDataSupport} class is the <i>open data</i> class which
|
||||
* implements the {@code CompositeData} interface.
|
||||
*
|
||||
*
|
||||
* @since 1.5
|
||||
@ -70,15 +70,15 @@ public class CompositeDataSupport
|
||||
private final CompositeType compositeType;
|
||||
|
||||
/**
|
||||
* <p>Constructs a <tt>CompositeDataSupport</tt> instance with the specified
|
||||
* <tt>compositeType</tt>, whose item values
|
||||
* are specified by <tt>itemValues[]</tt>, in the same order as in
|
||||
* <tt>itemNames[]</tt>.
|
||||
* As a <tt>CompositeType</tt> does not specify any order on its items,
|
||||
* the <tt>itemNames[]</tt> parameter is used
|
||||
* to specify the order in which the values are given in <tt>itemValues[]</tt>.
|
||||
* The items contained in this <tt>CompositeDataSupport</tt> instance are
|
||||
* internally stored in a <tt>TreeMap</tt>,
|
||||
* <p>Constructs a {@code CompositeDataSupport} instance with the specified
|
||||
* {@code compositeType}, whose item values
|
||||
* are specified by {@code itemValues[]}, in the same order as in
|
||||
* {@code itemNames[]}.
|
||||
* As a {@code CompositeType} does not specify any order on its items,
|
||||
* the {@code itemNames[]} parameter is used
|
||||
* to specify the order in which the values are given in {@code itemValues[]}.
|
||||
* The items contained in this {@code CompositeDataSupport} instance are
|
||||
* internally stored in a {@code TreeMap},
|
||||
* thus sorted in ascending lexicographic order of their names, for faster
|
||||
* retrieval of individual item values.</p>
|
||||
*
|
||||
@ -89,28 +89,28 @@ public class CompositeDataSupport
|
||||
* @param compositeType the <i>composite type </i> of this <i>composite
|
||||
* data</i> instance; must not be null.
|
||||
*
|
||||
* @param itemNames <tt>itemNames</tt> must list, in any order, all the
|
||||
* item names defined in <tt>compositeType</tt>; the order in which the
|
||||
* names are listed, is used to match values in <tt>itemValues[]</tt>; must
|
||||
* @param itemNames {@code itemNames} must list, in any order, all the
|
||||
* item names defined in {@code compositeType}; the order in which the
|
||||
* names are listed, is used to match values in {@code itemValues[]}; must
|
||||
* not be null or empty.
|
||||
*
|
||||
* @param itemValues the values of the items, listed in the same order as
|
||||
* their respective names in <tt>itemNames</tt>; each item value can be
|
||||
* their respective names in {@code itemNames}; each item value can be
|
||||
* null, but if it is non-null it must be a valid value for the open type
|
||||
* defined in <tt>compositeType</tt> for the corresponding item; must be of
|
||||
* the same size as <tt>itemNames</tt>; must not be null or empty.
|
||||
* defined in {@code compositeType} for the corresponding item; must be of
|
||||
* the same size as {@code itemNames}; must not be null or empty.
|
||||
*
|
||||
* @throws IllegalArgumentException <tt>compositeType</tt> is null, or
|
||||
* <tt>itemNames[]</tt> or <tt>itemValues[]</tt> is null or empty, or one
|
||||
* of the elements in <tt>itemNames[]</tt> is a null or empty string, or
|
||||
* <tt>itemNames[]</tt> and <tt>itemValues[]</tt> are not of the same size.
|
||||
* @throws IllegalArgumentException {@code compositeType} is null, or
|
||||
* {@code itemNames[]} or {@code itemValues[]} is null or empty, or one
|
||||
* of the elements in {@code itemNames[]} is a null or empty string, or
|
||||
* {@code itemNames[]} and {@code itemValues[]} are not of the same size.
|
||||
*
|
||||
* @throws OpenDataException <tt>itemNames[]</tt> or
|
||||
* <tt>itemValues[]</tt>'s size differs from the number of items defined in
|
||||
* <tt>compositeType</tt>, or one of the elements in <tt>itemNames[]</tt>
|
||||
* does not exist as an item name defined in <tt>compositeType</tt>, or one
|
||||
* of the elements in <tt>itemValues[]</tt> is not a valid value for the
|
||||
* corresponding item as defined in <tt>compositeType</tt>.
|
||||
* @throws OpenDataException {@code itemNames[]} or
|
||||
* {@code itemValues[]}'s size differs from the number of items defined in
|
||||
* {@code compositeType}, or one of the elements in {@code itemNames[]}
|
||||
* does not exist as an item name defined in {@code compositeType}, or one
|
||||
* of the elements in {@code itemValues[]} is not a valid value for the
|
||||
* corresponding item as defined in {@code compositeType}.
|
||||
*/
|
||||
public CompositeDataSupport(
|
||||
CompositeType compositeType, String[] itemNames, Object[] itemValues)
|
||||
@ -147,28 +147,29 @@ public class CompositeDataSupport
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* Constructs a <tt>CompositeDataSupport</tt> instance with the specified <tt>compositeType</tt>, whose item names and corresponding values
|
||||
* are given by the mappings in the map <tt>items</tt>.
|
||||
* Constructs a {@code CompositeDataSupport} instance with the specified {@code compositeType},
|
||||
* whose item names and corresponding values
|
||||
* are given by the mappings in the map {@code items}.
|
||||
* This constructor converts the keys to a string array and the values to an object array and calls
|
||||
* <tt>CompositeDataSupport(javax.management.openmbean.CompositeType, java.lang.String[], java.lang.Object[])</tt>.
|
||||
* {@code CompositeDataSupport(javax.management.openmbean.CompositeType, java.lang.String[], java.lang.Object[])}.
|
||||
*
|
||||
* @param compositeType the <i>composite type </i> of this <i>composite data</i> instance;
|
||||
* must not be null.
|
||||
* @param items the mappings of all the item names to their values;
|
||||
* <tt>items</tt> must contain all the item names defined in <tt>compositeType</tt>;
|
||||
* {@code items} must contain all the item names defined in {@code compositeType};
|
||||
* must not be null or empty.
|
||||
*
|
||||
* @throws IllegalArgumentException <tt>compositeType</tt> is null, or
|
||||
* <tt>items</tt> is null or empty, or one of the keys in <tt>items</tt> is a null
|
||||
* @throws IllegalArgumentException {@code compositeType} is null, or
|
||||
* {@code items} is null or empty, or one of the keys in {@code items} is a null
|
||||
* or empty string.
|
||||
* @throws OpenDataException <tt>items</tt>' size differs from the
|
||||
* number of items defined in <tt>compositeType</tt>, or one of the
|
||||
* keys in <tt>items</tt> does not exist as an item name defined in
|
||||
* <tt>compositeType</tt>, or one of the values in <tt>items</tt>
|
||||
* @throws OpenDataException {@code items}' size differs from the
|
||||
* number of items defined in {@code compositeType}, or one of the
|
||||
* keys in {@code items} does not exist as an item name defined in
|
||||
* {@code compositeType}, or one of the values in {@code items}
|
||||
* is not a valid value for the corresponding item as defined in
|
||||
* <tt>compositeType</tt>.
|
||||
* @throws ArrayStoreException one or more keys in <tt>items</tt> is not of
|
||||
* the class <tt>java.lang.String</tt>.
|
||||
* {@code compositeType}.
|
||||
* @throws ArrayStoreException one or more keys in {@code items} is not of
|
||||
* the class {@code java.lang.String}.
|
||||
*/
|
||||
public CompositeDataSupport(CompositeType compositeType,
|
||||
Map<String,?> items)
|
||||
@ -253,12 +254,12 @@ public class CompositeDataSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the value of the item whose name is <tt>key</tt>.
|
||||
* Returns the value of the item whose name is {@code key}.
|
||||
*
|
||||
* @throws IllegalArgumentException if <tt>key</tt> is a null or empty String.
|
||||
* @throws IllegalArgumentException if {@code key} is a null or empty String.
|
||||
*
|
||||
* @throws InvalidKeyException if <tt>key</tt> is not an existing item name for
|
||||
* this <tt>CompositeData</tt> instance.
|
||||
* @throws InvalidKeyException if {@code key} is not an existing item name for
|
||||
* this {@code CompositeData} instance.
|
||||
*/
|
||||
public Object get(String key) {
|
||||
|
||||
@ -273,13 +274,13 @@ public class CompositeDataSupport
|
||||
|
||||
/**
|
||||
* Returns an array of the values of the items whose names are specified by
|
||||
* <tt>keys</tt>, in the same order as <tt>keys</tt>.
|
||||
* {@code keys}, in the same order as {@code keys}.
|
||||
*
|
||||
* @throws IllegalArgumentException if an element in <tt>keys</tt> is a null
|
||||
* @throws IllegalArgumentException if an element in {@code keys} is a null
|
||||
* or empty String.
|
||||
*
|
||||
* @throws InvalidKeyException if an element in <tt>keys</tt> is not an existing
|
||||
* item name for this <tt>CompositeData</tt> instance.
|
||||
* @throws InvalidKeyException if an element in {@code keys} is not an existing
|
||||
* item name for this {@code CompositeData} instance.
|
||||
*/
|
||||
public Object[] getAll(String[] keys) {
|
||||
|
||||
@ -294,9 +295,9 @@ public class CompositeDataSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if and only if this <tt>CompositeData</tt> instance contains
|
||||
* an item whose name is <tt>key</tt>.
|
||||
* If <tt>key</tt> is a null or empty String, this method simply returns false.
|
||||
* Returns {@code true} if and only if this {@code CompositeData} instance contains
|
||||
* an item whose name is {@code key}.
|
||||
* If {@code key} is a null or empty String, this method simply returns false.
|
||||
*/
|
||||
public boolean containsKey(String key) {
|
||||
|
||||
@ -307,9 +308,9 @@ public class CompositeDataSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if and only if this <tt>CompositeData</tt> instance
|
||||
* Returns {@code true} if and only if this {@code CompositeData} instance
|
||||
* contains an item
|
||||
* whose value is <tt>value</tt>.
|
||||
* whose value is {@code value}.
|
||||
*/
|
||||
public boolean containsValue(Object value) {
|
||||
|
||||
@ -318,7 +319,7 @@ public class CompositeDataSupport
|
||||
|
||||
/**
|
||||
* Returns an unmodifiable Collection view of the item values contained in this
|
||||
* <tt>CompositeData</tt> instance.
|
||||
* {@code CompositeData} instance.
|
||||
* The returned collection's iterator will return the values in the ascending
|
||||
* lexicographic order of the corresponding
|
||||
* item names.
|
||||
@ -332,7 +333,7 @@ public class CompositeDataSupport
|
||||
* Compares the specified <var>obj</var> parameter with this
|
||||
* <code>CompositeDataSupport</code> instance for equality.
|
||||
* <p>
|
||||
* Returns <tt>true</tt> if and only if all of the following statements are true:
|
||||
* Returns {@code true} if and only if all of the following statements are true:
|
||||
* <ul>
|
||||
* <li><var>obj</var> is non null,</li>
|
||||
* <li><var>obj</var> also implements the <code>CompositeData</code> interface,</li>
|
||||
@ -344,11 +345,11 @@ public class CompositeDataSupport
|
||||
* {@code Arrays.equals(e1,e2)} for arrays of primitive types</li>
|
||||
* </ul>
|
||||
* <p>
|
||||
* This ensures that this <tt>equals</tt> method works properly for
|
||||
* This ensures that this {@code equals} method works properly for
|
||||
* <var>obj</var> parameters which are different implementations of the
|
||||
* <code>CompositeData</code> interface, with the restrictions mentioned in the
|
||||
* {@link java.util.Collection#equals(Object) equals}
|
||||
* method of the <tt>java.util.Collection</tt> interface.
|
||||
* method of the {@code java.util.Collection} interface.
|
||||
*
|
||||
* @param obj the object to be compared for equality with this
|
||||
* <code>CompositeDataSupport</code> instance.
|
||||
|
@ -53,27 +53,28 @@ public interface OpenMBeanAttributeInfo extends OpenMBeanParameterInfo {
|
||||
// (these will be removed when MBeanAttributeInfo is made a parent interface of this interface)
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if the attribute described by this <tt>OpenMBeanAttributeInfo</tt> instance is readable,
|
||||
* <tt>false</tt> otherwise.
|
||||
* Returns {@code true} if the attribute described by this {@code OpenMBeanAttributeInfo}
|
||||
* instance is readable, {@code false} otherwise.
|
||||
*
|
||||
* @return true if the attribute is readable.
|
||||
*/
|
||||
public boolean isReadable() ;
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if the attribute described by this <tt>OpenMBeanAttributeInfo</tt> instance is writable,
|
||||
* <tt>false</tt> otherwise.
|
||||
* Returns {@code true} if the attribute described by this {@code OpenMBeanAttributeInfo}
|
||||
* instance is writable, {@code false} otherwise.
|
||||
*
|
||||
* @return true if the attribute is writable.
|
||||
*/
|
||||
public boolean isWritable() ;
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if the attribute described by this <tt>OpenMBeanAttributeInfo</tt> instance
|
||||
* is accessed through a <tt>is<i>XXX</i></tt> getter (applies only to <tt>boolean</tt> and <tt>Boolean</tt> values),
|
||||
* <tt>false</tt> otherwise.
|
||||
* Returns {@code true} if the attribute described by this {@code OpenMBeanAttributeInfo} instance
|
||||
* is accessed through a <code>is<i>XXX</i></code> getter
|
||||
* (applies only to {@code boolean} and {@code Boolean} values),
|
||||
* {@code false} otherwise.
|
||||
*
|
||||
* @return true if the attribute is accessed through <tt>is<i>XXX</i></tt>.
|
||||
* @return true if the attribute is accessed through <code>is<i>XXX</i></code>.
|
||||
*/
|
||||
public boolean isIs() ;
|
||||
|
||||
@ -82,50 +83,52 @@ public interface OpenMBeanAttributeInfo extends OpenMBeanParameterInfo {
|
||||
//
|
||||
|
||||
/**
|
||||
* Compares the specified <var>obj</var> parameter with this <code>OpenMBeanAttributeInfo</code> instance for equality.
|
||||
* Compares the specified <var>obj</var> parameter with this
|
||||
* {@code OpenMBeanAttributeInfo} instance for equality.
|
||||
* <p>
|
||||
* Returns <tt>true</tt> if and only if all of the following statements are true:
|
||||
* Returns {@code true} if and only if all of the following statements are true:
|
||||
* <ul>
|
||||
* <li><var>obj</var> is non null,</li>
|
||||
* <li><var>obj</var> also implements the <code>OpenMBeanAttributeInfo</code> interface,</li>
|
||||
* <li><var>obj</var> also implements the {@code OpenMBeanAttributeInfo} interface,</li>
|
||||
* <li>their names are equal</li>
|
||||
* <li>their open types are equal</li>
|
||||
* <li>their access properties (isReadable, isWritable and isIs) are equal</li>
|
||||
* <li>their default, min, max and legal values are equal.</li>
|
||||
* </ul>
|
||||
* This ensures that this <tt>equals</tt> method works properly for <var>obj</var> parameters which are
|
||||
* different implementations of the <code>OpenMBeanAttributeInfo</code> interface.
|
||||
* This ensures that this {@code equals} method works properly for <var>obj</var> parameters which are
|
||||
* different implementations of the {@code OpenMBeanAttributeInfo} interface.
|
||||
* <br>
|
||||
* @param obj the object to be compared for equality with this <code>OpenMBeanAttributeInfo</code> instance;
|
||||
* @param obj the object to be compared for equality with this {@code OpenMBeanAttributeInfo} instance;
|
||||
*
|
||||
* @return <code>true</code> if the specified object is equal to this <code>OpenMBeanAttributeInfo</code> instance.
|
||||
* @return {@code true} if the specified object is equal to this {@code OpenMBeanAttributeInfo} instance.
|
||||
*/
|
||||
public boolean equals(Object obj);
|
||||
|
||||
/**
|
||||
* Returns the hash code value for this <code>OpenMBeanAttributeInfo</code> instance.
|
||||
* Returns the hash code value for this {@code OpenMBeanAttributeInfo} instance.
|
||||
* <p>
|
||||
* The hash code of an <code>OpenMBeanAttributeInfo</code> instance is the sum of the hash codes
|
||||
* of all elements of information used in <code>equals</code> comparisons
|
||||
* The hash code of an {@code OpenMBeanAttributeInfo} instance is the sum of the hash codes
|
||||
* of all elements of information used in {@code equals} comparisons
|
||||
* (ie: its name, its <i>open type</i>, and its default, min, max and legal values).
|
||||
* <p>
|
||||
* This ensures that <code> t1.equals(t2) </code> implies that <code> t1.hashCode()==t2.hashCode() </code>
|
||||
* for any two <code>OpenMBeanAttributeInfo</code> instances <code>t1</code> and <code>t2</code>,
|
||||
* This ensures that {@code t1.equals(t2)} implies that {@code t1.hashCode()==t2.hashCode()}
|
||||
* for any two {@code OpenMBeanAttributeInfo} instances {@code t1} and {@code t2},
|
||||
* as required by the general contract of the method
|
||||
* {@link Object#hashCode() Object.hashCode()}.
|
||||
*
|
||||
* @return the hash code value for this <code>OpenMBeanAttributeInfo</code> instance
|
||||
* @return the hash code value for this {@code OpenMBeanAttributeInfo} instance
|
||||
*/
|
||||
public int hashCode();
|
||||
|
||||
/**
|
||||
* Returns a string representation of this <code>OpenMBeanAttributeInfo</code> instance.
|
||||
* Returns a string representation of this {@code OpenMBeanAttributeInfo} instance.
|
||||
* <p>
|
||||
* The string representation consists of the name of this class (ie <code>javax.management.openmbean.OpenMBeanAttributeInfo</code>),
|
||||
* The string representation consists of the name of this class
|
||||
* (ie {@code javax.management.openmbean.OpenMBeanAttributeInfo}),
|
||||
* the string representation of the name and open type of the described attribute,
|
||||
* and the string representation of its default, min, max and legal values.
|
||||
*
|
||||
* @return a string representation of this <code>OpenMBeanAttributeInfo</code> instance
|
||||
* @return a string representation of this {@code OpenMBeanAttributeInfo} instance
|
||||
*/
|
||||
public String toString();
|
||||
|
||||
|
10
jdk/src/java.management/share/classes/javax/management/openmbean/OpenMBeanAttributeInfoSupport.java
10
jdk/src/java.management/share/classes/javax/management/openmbean/OpenMBeanAttributeInfoSupport.java
@ -114,7 +114,7 @@ public class OpenMBeanAttributeInfoSupport
|
||||
* exposed for management.
|
||||
*
|
||||
* @param isIs {@code true} if the attribute's getter is of the
|
||||
* form <tt>is<i>XXX</i></tt>.
|
||||
* form <code>is<i>XXX</i></code>.
|
||||
*
|
||||
* @throws IllegalArgumentException if {@code name} or {@code
|
||||
* description} are null or empty string, or {@code openType} is
|
||||
@ -154,7 +154,7 @@ public class OpenMBeanAttributeInfoSupport
|
||||
* exposed for management.
|
||||
*
|
||||
* @param isIs {@code true} if the attribute's getter is of the
|
||||
* form <tt>is<i>XXX</i></tt>.
|
||||
* form <code>is<i>XXX</i></code>.
|
||||
*
|
||||
* @param descriptor The descriptor for the attribute. This may be null
|
||||
* which is equivalent to an empty descriptor.
|
||||
@ -221,7 +221,7 @@ public class OpenMBeanAttributeInfoSupport
|
||||
* exposed for management.
|
||||
*
|
||||
* @param isIs {@code true} if the attribute's getter is of the
|
||||
* form <tt>is<i>XXX</i></tt>.
|
||||
* form <code>is<i>XXX</i></code>.
|
||||
*
|
||||
* @param defaultValue must be a valid value for the {@code
|
||||
* openType} specified for this attribute; default value not
|
||||
@ -278,7 +278,7 @@ public class OpenMBeanAttributeInfoSupport
|
||||
* exposed for management.
|
||||
*
|
||||
* @param isIs {@code true} if the attribute's getter is of the
|
||||
* form <tt>is<i>XXX</i></tt>.
|
||||
* form <code>is<i>XXX</i></code>.
|
||||
*
|
||||
* @param defaultValue must be a valid value
|
||||
* for the {@code
|
||||
@ -345,7 +345,7 @@ public class OpenMBeanAttributeInfoSupport
|
||||
* exposed for management.
|
||||
*
|
||||
* @param isIs {@code true} if the attribute's getter is of the
|
||||
* form <tt>is<i>XXX</i></tt>.
|
||||
* form <code>is<i>XXX</i></code>.
|
||||
*
|
||||
* @param defaultValue must be a valid value for the {@code
|
||||
* openType} specified for this attribute; default value not
|
||||
|
@ -60,7 +60,7 @@ public interface OpenMBeanConstructorInfo {
|
||||
|
||||
/**
|
||||
* Returns a human readable description of the constructor
|
||||
* described by this <tt>OpenMBeanConstructorInfo</tt> instance.
|
||||
* described by this {@code OpenMBeanConstructorInfo} instance.
|
||||
*
|
||||
* @return the description.
|
||||
*/
|
||||
@ -68,16 +68,16 @@ public interface OpenMBeanConstructorInfo {
|
||||
|
||||
/**
|
||||
* Returns the name of the constructor
|
||||
* described by this <tt>OpenMBeanConstructorInfo</tt> instance.
|
||||
* described by this {@code OpenMBeanConstructorInfo} instance.
|
||||
*
|
||||
* @return the name.
|
||||
*/
|
||||
public String getName() ;
|
||||
|
||||
/**
|
||||
* Returns an array of <tt>OpenMBeanParameterInfo</tt> instances
|
||||
* Returns an array of {@code OpenMBeanParameterInfo} instances
|
||||
* describing each parameter in the signature of the constructor
|
||||
* described by this <tt>OpenMBeanConstructorInfo</tt> instance.
|
||||
* described by this {@code OpenMBeanConstructorInfo} instance.
|
||||
*
|
||||
* @return the signature.
|
||||
*/
|
||||
@ -88,48 +88,49 @@ public interface OpenMBeanConstructorInfo {
|
||||
//
|
||||
|
||||
/**
|
||||
* Compares the specified <var>obj</var> parameter with this <code>OpenMBeanConstructorInfo</code> instance for equality.
|
||||
* Compares the specified <var>obj</var> parameter with this {@code OpenMBeanConstructorInfo} instance for equality.
|
||||
* <p>
|
||||
* Returns <tt>true</tt> if and only if all of the following statements are true:
|
||||
* Returns {@code true} if and only if all of the following statements are true:
|
||||
* <ul>
|
||||
* <li><var>obj</var> is non null,</li>
|
||||
* <li><var>obj</var> also implements the <code>OpenMBeanConstructorInfo</code> interface,</li>
|
||||
* <li><var>obj</var> also implements the {@code OpenMBeanConstructorInfo} interface,</li>
|
||||
* <li>their names are equal</li>
|
||||
* <li>their signatures are equal.</li>
|
||||
* </ul>
|
||||
* This ensures that this <tt>equals</tt> method works properly for <var>obj</var> parameters which are
|
||||
* different implementations of the <code>OpenMBeanConstructorInfo</code> interface.
|
||||
* This ensures that this {@code equals} method works properly for <var>obj</var> parameters which are
|
||||
* different implementations of the {@code OpenMBeanConstructorInfo} interface.
|
||||
* <br>
|
||||
* @param obj the object to be compared for equality with this <code>OpenMBeanConstructorInfo</code> instance;
|
||||
* @param obj the object to be compared for equality with this {@code OpenMBeanConstructorInfo} instance;
|
||||
*
|
||||
* @return <code>true</code> if the specified object is equal to this <code>OpenMBeanConstructorInfo</code> instance.
|
||||
* @return {@code true} if the specified object is equal to this {@code OpenMBeanConstructorInfo} instance.
|
||||
*/
|
||||
public boolean equals(Object obj);
|
||||
|
||||
/**
|
||||
* Returns the hash code value for this <code>OpenMBeanConstructorInfo</code> instance.
|
||||
* Returns the hash code value for this {@code OpenMBeanConstructorInfo} instance.
|
||||
* <p>
|
||||
* The hash code of an <code>OpenMBeanConstructorInfo</code> instance is the sum of the hash codes
|
||||
* of all elements of information used in <code>equals</code> comparisons
|
||||
* The hash code of an {@code OpenMBeanConstructorInfo} instance is the sum of the hash codes
|
||||
* of all elements of information used in {@code equals} comparisons
|
||||
* (ie: its name and signature, where the signature hashCode is calculated by a call to
|
||||
* <tt>java.util.Arrays.asList(this.getSignature).hashCode()</tt>).
|
||||
* {@code java.util.Arrays.asList(this.getSignature).hashCode()}).
|
||||
* <p>
|
||||
* This ensures that <code> t1.equals(t2) </code> implies that <code> t1.hashCode()==t2.hashCode() </code>
|
||||
* for any two <code>OpenMBeanConstructorInfo</code> instances <code>t1</code> and <code>t2</code>,
|
||||
* This ensures that {@code t1.equals(t2)} implies that {@code t1.hashCode()==t2.hashCode()}
|
||||
* for any two {@code OpenMBeanConstructorInfo} instances {@code t1} and {@code t2},
|
||||
* as required by the general contract of the method
|
||||
* {@link Object#hashCode() Object.hashCode()}.
|
||||
*
|
||||
* @return the hash code value for this <code>OpenMBeanConstructorInfo</code> instance
|
||||
* @return the hash code value for this {@code OpenMBeanConstructorInfo} instance
|
||||
*/
|
||||
public int hashCode();
|
||||
|
||||
/**
|
||||
* Returns a string representation of this <code>OpenMBeanConstructorInfo</code> instance.
|
||||
* Returns a string representation of this {@code OpenMBeanConstructorInfo} instance.
|
||||
* <p>
|
||||
* The string representation consists of the name of this class (ie <code>javax.management.openmbean.OpenMBeanConstructorInfo</code>),
|
||||
* The string representation consists of the name of this class
|
||||
* (ie {@code javax.management.openmbean.OpenMBeanConstructorInfo}),
|
||||
* and the name and signature of the described constructor.
|
||||
*
|
||||
* @return a string representation of this <code>OpenMBeanConstructorInfo</code> instance
|
||||
* @return a string representation of this {@code OpenMBeanConstructorInfo} instance
|
||||
*/
|
||||
public String toString();
|
||||
|
||||
|
@ -70,7 +70,7 @@ public interface OpenMBeanInfo {
|
||||
|
||||
/**
|
||||
* Returns the fully qualified Java class name of the open MBean
|
||||
* instances this <tt>OpenMBeanInfo</tt> describes.
|
||||
* instances this {@code OpenMBeanInfo} describes.
|
||||
*
|
||||
* @return the class name.
|
||||
*/
|
||||
@ -78,19 +78,19 @@ public interface OpenMBeanInfo {
|
||||
|
||||
/**
|
||||
* Returns a human readable description of the type of open MBean
|
||||
* instances this <tt>OpenMBeanInfo</tt> describes.
|
||||
* instances this {@code OpenMBeanInfo} describes.
|
||||
*
|
||||
* @return the description.
|
||||
*/
|
||||
public String getDescription() ;
|
||||
|
||||
/**
|
||||
* Returns an array of <tt>OpenMBeanAttributeInfo</tt> instances
|
||||
* Returns an array of {@code OpenMBeanAttributeInfo} instances
|
||||
* describing each attribute in the open MBean described by this
|
||||
* <tt>OpenMBeanInfo</tt> instance. Each instance in the returned
|
||||
* {@code OpenMBeanInfo} instance. Each instance in the returned
|
||||
* array should actually be a subclass of
|
||||
* <tt>MBeanAttributeInfo</tt> which implements the
|
||||
* <tt>OpenMBeanAttributeInfo</tt> interface (typically {@link
|
||||
* {@code MBeanAttributeInfo} which implements the
|
||||
* {@code OpenMBeanAttributeInfo} interface (typically {@link
|
||||
* OpenMBeanAttributeInfoSupport}).
|
||||
*
|
||||
* @return the attribute array.
|
||||
@ -98,12 +98,12 @@ public interface OpenMBeanInfo {
|
||||
public MBeanAttributeInfo[] getAttributes() ;
|
||||
|
||||
/**
|
||||
* Returns an array of <tt>OpenMBeanOperationInfo</tt> instances
|
||||
* Returns an array of {@code OpenMBeanOperationInfo} instances
|
||||
* describing each operation in the open MBean described by this
|
||||
* <tt>OpenMBeanInfo</tt> instance. Each instance in the returned
|
||||
* {@code OpenMBeanInfo} instance. Each instance in the returned
|
||||
* array should actually be a subclass of
|
||||
* <tt>MBeanOperationInfo</tt> which implements the
|
||||
* <tt>OpenMBeanOperationInfo</tt> interface (typically {@link
|
||||
* {@code MBeanOperationInfo} which implements the
|
||||
* {@code OpenMBeanOperationInfo} interface (typically {@link
|
||||
* OpenMBeanOperationInfoSupport}).
|
||||
*
|
||||
* @return the operation array.
|
||||
@ -111,12 +111,12 @@ public interface OpenMBeanInfo {
|
||||
public MBeanOperationInfo[] getOperations() ;
|
||||
|
||||
/**
|
||||
* Returns an array of <tt>OpenMBeanConstructorInfo</tt> instances
|
||||
* Returns an array of {@code OpenMBeanConstructorInfo} instances
|
||||
* describing each constructor in the open MBean described by this
|
||||
* <tt>OpenMBeanInfo</tt> instance. Each instance in the returned
|
||||
* {@code OpenMBeanInfo} instance. Each instance in the returned
|
||||
* array should actually be a subclass of
|
||||
* <tt>MBeanConstructorInfo</tt> which implements the
|
||||
* <tt>OpenMBeanConstructorInfo</tt> interface (typically {@link
|
||||
* {@code MBeanConstructorInfo} which implements the
|
||||
* {@code OpenMBeanConstructorInfo} interface (typically {@link
|
||||
* OpenMBeanConstructorInfoSupport}).
|
||||
*
|
||||
* @return the constructor array.
|
||||
@ -124,9 +124,9 @@ public interface OpenMBeanInfo {
|
||||
public MBeanConstructorInfo[] getConstructors() ;
|
||||
|
||||
/**
|
||||
* Returns an array of <tt>MBeanNotificationInfo</tt> instances
|
||||
* Returns an array of {@code MBeanNotificationInfo} instances
|
||||
* describing each notification emitted by the open MBean
|
||||
* described by this <tt>OpenMBeanInfo</tt> instance.
|
||||
* described by this {@code OpenMBeanInfo} instance.
|
||||
*
|
||||
* @return the notification array.
|
||||
*/
|
||||
@ -137,50 +137,51 @@ public interface OpenMBeanInfo {
|
||||
//
|
||||
|
||||
/**
|
||||
* Compares the specified <var>obj</var> parameter with this <code>OpenMBeanInfo</code> instance for equality.
|
||||
* Compares the specified <var>obj</var> parameter with this {@code OpenMBeanInfo} instance for equality.
|
||||
* <p>
|
||||
* Returns <tt>true</tt> if and only if all of the following statements are true:
|
||||
* Returns {@code true} if and only if all of the following statements are true:
|
||||
* <ul>
|
||||
* <li><var>obj</var> is non null,</li>
|
||||
* <li><var>obj</var> also implements the <code>OpenMBeanInfo</code> interface,</li>
|
||||
* <li><var>obj</var> also implements the {@code OpenMBeanInfo} interface,</li>
|
||||
* <li>their class names are equal</li>
|
||||
* <li>their infos on attributes, constructors, operations and notifications are equal</li>
|
||||
* </ul>
|
||||
* This ensures that this <tt>equals</tt> method works properly for <var>obj</var> parameters which are
|
||||
* different implementations of the <code>OpenMBeanInfo</code> interface.
|
||||
* <br>
|
||||
* @param obj the object to be compared for equality with this <code>OpenMBeanInfo</code> instance;
|
||||
* This ensures that this {@code equals} method works properly for <var>obj</var> parameters which are
|
||||
* different implementations of the {@code OpenMBeanInfo} interface.
|
||||
*
|
||||
* @return <code>true</code> if the specified object is equal to this <code>OpenMBeanInfo</code> instance.
|
||||
* @param obj the object to be compared for equality with this {@code OpenMBeanInfo} instance;
|
||||
*
|
||||
* @return {@code true} if the specified object is equal to this {@code OpenMBeanInfo} instance.
|
||||
*/
|
||||
public boolean equals(Object obj);
|
||||
|
||||
/**
|
||||
* Returns the hash code value for this <code>OpenMBeanInfo</code> instance.
|
||||
* Returns the hash code value for this {@code OpenMBeanInfo} instance.
|
||||
* <p>
|
||||
* The hash code of an <code>OpenMBeanInfo</code> instance is the sum of the hash codes
|
||||
* of all elements of information used in <code>equals</code> comparisons
|
||||
* The hash code of an {@code OpenMBeanInfo} instance is the sum of the hash codes
|
||||
* of all elements of information used in {@code equals} comparisons
|
||||
* (ie: its class name, and its infos on attributes, constructors, operations and notifications,
|
||||
* where the hashCode of each of these arrays is calculated by a call to
|
||||
* <tt>new java.util.HashSet(java.util.Arrays.asList(this.getSignature)).hashCode()</tt>).
|
||||
* {@code new java.util.HashSet(java.util.Arrays.asList(this.getSignature)).hashCode()}).
|
||||
* <p>
|
||||
* This ensures that <code> t1.equals(t2) </code> implies that <code> t1.hashCode()==t2.hashCode() </code>
|
||||
* for any two <code>OpenMBeanInfo</code> instances <code>t1</code> and <code>t2</code>,
|
||||
* This ensures that {@code t1.equals(t2)} implies that {@code t1.hashCode()==t2.hashCode()}
|
||||
* for any two {@code OpenMBeanInfo} instances {@code t1} and {@code t2},
|
||||
* as required by the general contract of the method
|
||||
* {@link Object#hashCode() Object.hashCode()}.
|
||||
*
|
||||
* @return the hash code value for this <code>OpenMBeanInfo</code> instance
|
||||
* @return the hash code value for this {@code OpenMBeanInfo} instance
|
||||
*/
|
||||
public int hashCode();
|
||||
|
||||
/**
|
||||
* Returns a string representation of this <code>OpenMBeanInfo</code> instance.
|
||||
* Returns a string representation of this {@code OpenMBeanInfo} instance.
|
||||
* <p>
|
||||
* The string representation consists of the name of this class (ie <code>javax.management.openmbean.OpenMBeanInfo</code>),
|
||||
* the MBean class name,
|
||||
* and the string representation of infos on attributes, constructors, operations and notifications of the described MBean.
|
||||
* The string representation consists of the name of this class
|
||||
* (ie {@code javax.management.openmbean.OpenMBeanInfo}), the MBean class name,
|
||||
* and the string representation of infos on attributes, constructors,
|
||||
* operations and notifications of the described MBean.
|
||||
*
|
||||
* @return a string representation of this <code>OpenMBeanInfo</code> instance
|
||||
* @return a string representation of this {@code OpenMBeanInfo} instance
|
||||
*/
|
||||
public String toString();
|
||||
|
||||
|
@ -58,7 +58,7 @@ public interface OpenMBeanOperationInfo {
|
||||
|
||||
/**
|
||||
* Returns a human readable description of the operation
|
||||
* described by this <tt>OpenMBeanOperationInfo</tt> instance.
|
||||
* described by this {@code OpenMBeanOperationInfo} instance.
|
||||
*
|
||||
* @return the description.
|
||||
*/
|
||||
@ -66,19 +66,19 @@ public interface OpenMBeanOperationInfo {
|
||||
|
||||
/**
|
||||
* Returns the name of the operation
|
||||
* described by this <tt>OpenMBeanOperationInfo</tt> instance.
|
||||
* described by this {@code OpenMBeanOperationInfo} instance.
|
||||
*
|
||||
* @return the name.
|
||||
*/
|
||||
public String getName() ;
|
||||
|
||||
/**
|
||||
* Returns an array of <tt>OpenMBeanParameterInfo</tt> instances
|
||||
* Returns an array of {@code OpenMBeanParameterInfo} instances
|
||||
* describing each parameter in the signature of the operation
|
||||
* described by this <tt>OpenMBeanOperationInfo</tt> instance.
|
||||
* described by this {@code OpenMBeanOperationInfo} instance.
|
||||
* Each instance in the returned array should actually be a
|
||||
* subclass of <tt>MBeanParameterInfo</tt> which implements the
|
||||
* <tt>OpenMBeanParameterInfo</tt> interface (typically {@link
|
||||
* subclass of {@code MBeanParameterInfo} which implements the
|
||||
* {@code OpenMBeanParameterInfo} interface (typically {@link
|
||||
* OpenMBeanParameterInfoSupport}).
|
||||
*
|
||||
* @return the signature.
|
||||
@ -86,8 +86,8 @@ public interface OpenMBeanOperationInfo {
|
||||
public MBeanParameterInfo[] getSignature() ;
|
||||
|
||||
/**
|
||||
* Returns an <tt>int</tt> constant qualifying the impact of the
|
||||
* operation described by this <tt>OpenMBeanOperationInfo</tt>
|
||||
* Returns an {@code int} constant qualifying the impact of the
|
||||
* operation described by this {@code OpenMBeanOperationInfo}
|
||||
* instance.
|
||||
*
|
||||
* The returned constant is one of {@link
|
||||
@ -103,9 +103,9 @@ public interface OpenMBeanOperationInfo {
|
||||
/**
|
||||
* Returns the fully qualified Java class name of the values
|
||||
* returned by the operation described by this
|
||||
* <tt>OpenMBeanOperationInfo</tt> instance. This method should
|
||||
* {@code OpenMBeanOperationInfo} instance. This method should
|
||||
* return the same value as a call to
|
||||
* <tt>getReturnOpenType().getClassName()</tt>.
|
||||
* {@code getReturnOpenType().getClassName()}.
|
||||
*
|
||||
* @return the return type.
|
||||
*/
|
||||
@ -117,7 +117,7 @@ public interface OpenMBeanOperationInfo {
|
||||
|
||||
/**
|
||||
* Returns the <i>open type</i> of the values returned by the
|
||||
* operation described by this <tt>OpenMBeanOperationInfo</tt>
|
||||
* operation described by this {@code OpenMBeanOperationInfo}
|
||||
* instance.
|
||||
*
|
||||
* @return the return type.
|
||||
@ -129,51 +129,53 @@ public interface OpenMBeanOperationInfo {
|
||||
//
|
||||
|
||||
/**
|
||||
* Compares the specified <var>obj</var> parameter with this <code>OpenMBeanOperationInfo</code> instance for equality.
|
||||
* Compares the specified <var>obj</var> parameter with this {@code OpenMBeanOperationInfo} instance for equality.
|
||||
* <p>
|
||||
* Returns <tt>true</tt> if and only if all of the following statements are true:
|
||||
* Returns {@code true} if and only if all of the following statements are true:
|
||||
* <ul>
|
||||
* <li><var>obj</var> is non null,</li>
|
||||
* <li><var>obj</var> also implements the <code>OpenMBeanOperationInfo</code> interface,</li>
|
||||
* <li><var>obj</var> also implements the {@code OpenMBeanOperationInfo} interface,</li>
|
||||
* <li>their names are equal</li>
|
||||
* <li>their signatures are equal</li>
|
||||
* <li>their return open types are equal</li>
|
||||
* <li>their impacts are equal</li>
|
||||
* </ul>
|
||||
* This ensures that this <tt>equals</tt> method works properly for <var>obj</var> parameters which are
|
||||
* different implementations of the <code>OpenMBeanOperationInfo</code> interface.
|
||||
* This ensures that this {@code equals} method works properly for <var>obj</var> parameters which are
|
||||
* different implementations of the {@code OpenMBeanOperationInfo} interface.
|
||||
* <br>
|
||||
* @param obj the object to be compared for equality with this <code>OpenMBeanOperationInfo</code> instance;
|
||||
* @param obj the object to be compared for equality with this {@code OpenMBeanOperationInfo} instance;
|
||||
*
|
||||
* @return <code>true</code> if the specified object is equal to this <code>OpenMBeanOperationInfo</code> instance.
|
||||
* @return {@code true} if the specified object is equal to this {@code OpenMBeanOperationInfo} instance.
|
||||
*/
|
||||
public boolean equals(Object obj);
|
||||
|
||||
/**
|
||||
* Returns the hash code value for this <code>OpenMBeanOperationInfo</code> instance.
|
||||
* Returns the hash code value for this {@code OpenMBeanOperationInfo} instance.
|
||||
* <p>
|
||||
* The hash code of an <code>OpenMBeanOperationInfo</code> instance is the sum of the hash codes
|
||||
* of all elements of information used in <code>equals</code> comparisons
|
||||
* (ie: its name, return open type, impact and signature, where the signature hashCode is calculated by a call to
|
||||
* <tt>java.util.Arrays.asList(this.getSignature).hashCode()</tt>).
|
||||
* The hash code of an {@code OpenMBeanOperationInfo} instance is the sum of the hash codes
|
||||
* of all elements of information used in {@code equals} comparisons
|
||||
* (ie: its name, return open type, impact and signature,
|
||||
* where the signature hashCode is calculated by a call to
|
||||
* {@code java.util.Arrays.asList(this.getSignature).hashCode()}).
|
||||
* <p>
|
||||
* This ensures that <code> t1.equals(t2) </code> implies that <code> t1.hashCode()==t2.hashCode() </code>
|
||||
* for any two <code>OpenMBeanOperationInfo</code> instances <code>t1</code> and <code>t2</code>,
|
||||
* This ensures that {@code t1.equals(t2)} implies that {@code t1.hashCode()==t2.hashCode()}
|
||||
* for any two {@code OpenMBeanOperationInfo} instances {@code t1} and {@code t2},
|
||||
* as required by the general contract of the method
|
||||
* {@link Object#hashCode() Object.hashCode()}.
|
||||
*
|
||||
*
|
||||
* @return the hash code value for this <code>OpenMBeanOperationInfo</code> instance
|
||||
* @return the hash code value for this {@code OpenMBeanOperationInfo} instance
|
||||
*/
|
||||
public int hashCode();
|
||||
|
||||
/**
|
||||
* Returns a string representation of this <code>OpenMBeanOperationInfo</code> instance.
|
||||
* Returns a string representation of this {@code OpenMBeanOperationInfo} instance.
|
||||
* <p>
|
||||
* The string representation consists of the name of this class (ie <code>javax.management.openmbean.OpenMBeanOperationInfo</code>),
|
||||
* The string representation consists of the name of this class
|
||||
* (ie {@code javax.management.openmbean.OpenMBeanOperationInfo}),
|
||||
* and the name, signature, return open type and impact of the described operation.
|
||||
*
|
||||
* @return a string representation of this <code>OpenMBeanOperationInfo</code> instance
|
||||
* @return a string representation of this {@code OpenMBeanOperationInfo} instance
|
||||
*/
|
||||
public String toString();
|
||||
|
||||
|
@ -57,7 +57,7 @@ public interface OpenMBeanParameterInfo {
|
||||
|
||||
/**
|
||||
* Returns a human readable description of the parameter
|
||||
* described by this <tt>OpenMBeanParameterInfo</tt> instance.
|
||||
* described by this {@code OpenMBeanParameterInfo} instance.
|
||||
*
|
||||
* @return the description.
|
||||
*/
|
||||
@ -65,7 +65,7 @@ public interface OpenMBeanParameterInfo {
|
||||
|
||||
/**
|
||||
* Returns the name of the parameter
|
||||
* described by this <tt>OpenMBeanParameterInfo</tt> instance.
|
||||
* described by this {@code OpenMBeanParameterInfo} instance.
|
||||
*
|
||||
* @return the name.
|
||||
*/
|
||||
@ -77,7 +77,7 @@ public interface OpenMBeanParameterInfo {
|
||||
|
||||
/**
|
||||
* Returns the <i>open type</i> of the values of the parameter
|
||||
* described by this <tt>OpenMBeanParameterInfo</tt> instance.
|
||||
* described by this {@code OpenMBeanParameterInfo} instance.
|
||||
*
|
||||
* @return the open type.
|
||||
*/
|
||||
@ -85,7 +85,7 @@ public interface OpenMBeanParameterInfo {
|
||||
|
||||
/**
|
||||
* Returns the default value for this parameter, if it has one, or
|
||||
* <tt>null</tt> otherwise.
|
||||
* {@code null} otherwise.
|
||||
*
|
||||
* @return the default value.
|
||||
*/
|
||||
@ -93,7 +93,7 @@ public interface OpenMBeanParameterInfo {
|
||||
|
||||
/**
|
||||
* Returns the set of legal values for this parameter, if it has
|
||||
* one, or <tt>null</tt> otherwise.
|
||||
* one, or {@code null} otherwise.
|
||||
*
|
||||
* @return the set of legal values.
|
||||
*/
|
||||
@ -101,7 +101,7 @@ public interface OpenMBeanParameterInfo {
|
||||
|
||||
/**
|
||||
* Returns the minimal value for this parameter, if it has one, or
|
||||
* <tt>null</tt> otherwise.
|
||||
* {@code null} otherwise.
|
||||
*
|
||||
* @return the minimum value.
|
||||
*/
|
||||
@ -109,39 +109,39 @@ public interface OpenMBeanParameterInfo {
|
||||
|
||||
/**
|
||||
* Returns the maximal value for this parameter, if it has one, or
|
||||
* <tt>null</tt> otherwise.
|
||||
* {@code null} otherwise.
|
||||
*
|
||||
* @return the maximum value.
|
||||
*/
|
||||
public Comparable<?> getMaxValue() ;
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if this parameter has a specified default
|
||||
* value, or <tt>false</tt> otherwise.
|
||||
* Returns {@code true} if this parameter has a specified default
|
||||
* value, or {@code false} otherwise.
|
||||
*
|
||||
* @return true if there is a default value.
|
||||
*/
|
||||
public boolean hasDefaultValue() ;
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if this parameter has a specified set of
|
||||
* legal values, or <tt>false</tt> otherwise.
|
||||
* Returns {@code true} if this parameter has a specified set of
|
||||
* legal values, or {@code false} otherwise.
|
||||
*
|
||||
* @return true if there is a set of legal values.
|
||||
*/
|
||||
public boolean hasLegalValues() ;
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if this parameter has a specified minimal
|
||||
* value, or <tt>false</tt> otherwise.
|
||||
* Returns {@code true} if this parameter has a specified minimal
|
||||
* value, or {@code false} otherwise.
|
||||
*
|
||||
* @return true if there is a minimum value.
|
||||
*/
|
||||
public boolean hasMinValue() ;
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if this parameter has a specified maximal
|
||||
* value, or <tt>false</tt> otherwise.
|
||||
* Returns {@code true} if this parameter has a specified maximal
|
||||
* value, or {@code false} otherwise.
|
||||
*
|
||||
* @return true if there is a maximum value.
|
||||
*/
|
||||
@ -149,62 +149,62 @@ public interface OpenMBeanParameterInfo {
|
||||
|
||||
/**
|
||||
* Tests whether <var>obj</var> is a valid value for the parameter
|
||||
* described by this <code>OpenMBeanParameterInfo</code> instance.
|
||||
* described by this {@code OpenMBeanParameterInfo} instance.
|
||||
*
|
||||
* @param obj the object to be tested.
|
||||
*
|
||||
* @return <code>true</code> if <var>obj</var> is a valid value
|
||||
* @return {@code true} if <var>obj</var> is a valid value
|
||||
* for the parameter described by this
|
||||
* <code>OpenMBeanParameterInfo</code> instance,
|
||||
* <code>false</code> otherwise.
|
||||
* {@code OpenMBeanParameterInfo} instance,
|
||||
* {@code false} otherwise.
|
||||
*/
|
||||
public boolean isValue(Object obj) ;
|
||||
|
||||
|
||||
/**
|
||||
* Compares the specified <var>obj</var> parameter with this <code>OpenMBeanParameterInfo</code> instance for equality.
|
||||
* Compares the specified <var>obj</var> parameter with this {@code OpenMBeanParameterInfo} instance for equality.
|
||||
* <p>
|
||||
* Returns <tt>true</tt> if and only if all of the following statements are true:
|
||||
* Returns {@code true} if and only if all of the following statements are true:
|
||||
* <ul>
|
||||
* <li><var>obj</var> is non null,</li>
|
||||
* <li><var>obj</var> also implements the <code>OpenMBeanParameterInfo</code> interface,</li>
|
||||
* <li><var>obj</var> also implements the {@code OpenMBeanParameterInfo} interface,</li>
|
||||
* <li>their names are equal</li>
|
||||
* <li>their open types are equal</li>
|
||||
* <li>their default, min, max and legal values are equal.</li>
|
||||
* </ul>
|
||||
* This ensures that this <tt>equals</tt> method works properly for <var>obj</var> parameters which are
|
||||
* different implementations of the <code>OpenMBeanParameterInfo</code> interface.
|
||||
* This ensures that this {@code equals} method works properly for <var>obj</var> parameters which are
|
||||
* different implementations of the {@code OpenMBeanParameterInfo} interface.
|
||||
* <br>
|
||||
* @param obj the object to be compared for equality with this <code>OpenMBeanParameterInfo</code> instance;
|
||||
* @param obj the object to be compared for equality with this {@code OpenMBeanParameterInfo} instance;
|
||||
*
|
||||
* @return <code>true</code> if the specified object is equal to this <code>OpenMBeanParameterInfo</code> instance.
|
||||
* @return {@code true} if the specified object is equal to this {@code OpenMBeanParameterInfo} instance.
|
||||
*/
|
||||
public boolean equals(Object obj);
|
||||
|
||||
/**
|
||||
* Returns the hash code value for this <code>OpenMBeanParameterInfo</code> instance.
|
||||
* Returns the hash code value for this {@code OpenMBeanParameterInfo} instance.
|
||||
* <p>
|
||||
* The hash code of an <code>OpenMBeanParameterInfo</code> instance is the sum of the hash codes
|
||||
* of all elements of information used in <code>equals</code> comparisons
|
||||
* The hash code of an {@code OpenMBeanParameterInfo} instance is the sum of the hash codes
|
||||
* of all elements of information used in {@code equals} comparisons
|
||||
* (ie: its name, its <i>open type</i>, and its default, min, max and legal values).
|
||||
* <p>
|
||||
* This ensures that <code> t1.equals(t2) </code> implies that <code> t1.hashCode()==t2.hashCode() </code>
|
||||
* for any two <code>OpenMBeanParameterInfo</code> instances <code>t1</code> and <code>t2</code>,
|
||||
* This ensures that {@code t1.equals(t2)} implies that {@code t1.hashCode()==t2.hashCode()}
|
||||
* for any two {@code OpenMBeanParameterInfo} instances {@code t1} and {@code t2},
|
||||
* as required by the general contract of the method
|
||||
* {@link Object#hashCode() Object.hashCode()}.
|
||||
*
|
||||
* @return the hash code value for this <code>OpenMBeanParameterInfo</code> instance
|
||||
* @return the hash code value for this {@code OpenMBeanParameterInfo} instance
|
||||
*/
|
||||
public int hashCode();
|
||||
|
||||
/**
|
||||
* Returns a string representation of this <code>OpenMBeanParameterInfo</code> instance.
|
||||
* Returns a string representation of this {@code OpenMBeanParameterInfo} instance.
|
||||
* <p>
|
||||
* The string representation consists of the name of this class (ie <code>javax.management.openmbean.OpenMBeanParameterInfo</code>),
|
||||
* The string representation consists of the name of this class (ie {@code javax.management.openmbean.OpenMBeanParameterInfo}),
|
||||
* the string representation of the name and open type of the described parameter,
|
||||
* and the string representation of its default, min, max and legal values.
|
||||
*
|
||||
* @return a string representation of this <code>OpenMBeanParameterInfo</code> instance
|
||||
* @return a string representation of this {@code OpenMBeanParameterInfo} instance
|
||||
*/
|
||||
public String toString();
|
||||
|
||||
|
@ -37,7 +37,7 @@ import java.util.Collection;
|
||||
|
||||
|
||||
/**
|
||||
* The <tt>TabularData</tt> interface specifies the behavior of a specific type of complex <i>open data</i> objects
|
||||
* The {@code TabularData} interface specifies the behavior of a specific type of complex <i>open data</i> objects
|
||||
* which represent <i>tabular data</i> structures.
|
||||
*
|
||||
* @since 1.5
|
||||
@ -50,7 +50,7 @@ public interface TabularData /*extends Map*/ {
|
||||
|
||||
/**
|
||||
* Returns the <i>tabular type</i> describing this
|
||||
* <tt>TabularData</tt> instance.
|
||||
* {@code TabularData} instance.
|
||||
*
|
||||
* @return the tabular type.
|
||||
*/
|
||||
@ -58,21 +58,21 @@ public interface TabularData /*extends Map*/ {
|
||||
|
||||
|
||||
/**
|
||||
* Calculates the index that would be used in this <tt>TabularData</tt> instance to refer to the specified
|
||||
* Calculates the index that would be used in this {@code TabularData} instance to refer to the specified
|
||||
* composite data <var>value</var> parameter if it were added to this instance.
|
||||
* This method checks for the type validity of the specified <var>value</var>,
|
||||
* but does not check if the calculated index is already used to refer to a value in this <tt>TabularData</tt> instance.
|
||||
* but does not check if the calculated index is already used to refer to a value in this {@code TabularData} instance.
|
||||
*
|
||||
* @param value the composite data value whose index in this
|
||||
* <tt>TabularData</tt> instance is to be calculated;
|
||||
* {@code TabularData} instance is to be calculated;
|
||||
* must be of the same composite type as this instance's row type;
|
||||
* must not be null.
|
||||
*
|
||||
* @return the index that the specified <var>value</var> would have in this <tt>TabularData</tt> instance.
|
||||
* @return the index that the specified <var>value</var> would have in this {@code TabularData} instance.
|
||||
*
|
||||
* @throws NullPointerException if <var>value</var> is <tt>null</tt>
|
||||
* @throws NullPointerException if <var>value</var> is {@code null}
|
||||
*
|
||||
* @throws InvalidOpenTypeException if <var>value</var> does not conform to this <tt>TabularData</tt> instance's
|
||||
* @throws InvalidOpenTypeException if <var>value</var> does not conform to this {@code TabularData} instance's
|
||||
* row type definition.
|
||||
*/
|
||||
public Object[] calculateIndex(CompositeData value) ;
|
||||
@ -83,8 +83,8 @@ public interface TabularData /*extends Map*/ {
|
||||
/* *** Content information query methods *** */
|
||||
|
||||
/**
|
||||
* Returns the number of <tt>CompositeData</tt> values (ie the
|
||||
* number of rows) contained in this <tt>TabularData</tt>
|
||||
* Returns the number of {@code CompositeData} values (ie the
|
||||
* number of rows) contained in this {@code TabularData}
|
||||
* instance.
|
||||
*
|
||||
* @return the number of values contained.
|
||||
@ -92,50 +92,50 @@ public interface TabularData /*extends Map*/ {
|
||||
public int size() ;
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if the number of <tt>CompositeData</tt>
|
||||
* Returns {@code true} if the number of {@code CompositeData}
|
||||
* values (ie the number of rows) contained in this
|
||||
* <tt>TabularData</tt> instance is zero.
|
||||
* {@code TabularData} instance is zero.
|
||||
*
|
||||
* @return true if this <tt>TabularData</tt> is empty.
|
||||
* @return true if this {@code TabularData} is empty.
|
||||
*/
|
||||
public boolean isEmpty() ;
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if and only if this <tt>TabularData</tt> instance contains a <tt>CompositeData</tt> value
|
||||
* (ie a row) whose index is the specified <var>key</var>. If <var>key</var> is <tt>null</tt> or does not conform to
|
||||
* this <tt>TabularData</tt> instance's <tt>TabularType</tt> definition, this method simply returns <tt>false</tt>.
|
||||
* Returns {@code true} if and only if this {@code TabularData} instance contains a {@code CompositeData} value
|
||||
* (ie a row) whose index is the specified <var>key</var>. If <var>key</var> is {@code null} or does not conform to
|
||||
* this {@code TabularData} instance's {@code TabularType} definition, this method simply returns {@code false}.
|
||||
*
|
||||
* @param key the index value whose presence in this <tt>TabularData</tt> instance is to be tested.
|
||||
* @param key the index value whose presence in this {@code TabularData} instance is to be tested.
|
||||
*
|
||||
* @return <tt>true</tt> if this <tt>TabularData</tt> indexes a row value with the specified key.
|
||||
* @return {@code true} if this {@code TabularData} indexes a row value with the specified key.
|
||||
*/
|
||||
public boolean containsKey(Object[] key) ;
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if and only if this <tt>TabularData</tt> instance contains the specified
|
||||
* <tt>CompositeData</tt> value. If <var>value</var> is <tt>null</tt> or does not conform to
|
||||
* this <tt>TabularData</tt> instance's row type definition, this method simply returns <tt>false</tt>.
|
||||
* Returns {@code true} if and only if this {@code TabularData} instance contains the specified
|
||||
* {@code CompositeData} value. If <var>value</var> is {@code null} or does not conform to
|
||||
* this {@code TabularData} instance's row type definition, this method simply returns {@code false}.
|
||||
*
|
||||
* @param value the row value whose presence in this <tt>TabularData</tt> instance is to be tested.
|
||||
* @param value the row value whose presence in this {@code TabularData} instance is to be tested.
|
||||
*
|
||||
* @return <tt>true</tt> if this <tt>TabularData</tt> instance contains the specified row value.
|
||||
* @return {@code true} if this {@code TabularData} instance contains the specified row value.
|
||||
*/
|
||||
public boolean containsValue(CompositeData value) ;
|
||||
|
||||
/**
|
||||
* Returns the <tt>CompositeData</tt> value whose index is
|
||||
* <var>key</var>, or <tt>null</tt> if there is no value mapping
|
||||
* to <var>key</var>, in this <tt>TabularData</tt> instance.
|
||||
* Returns the {@code CompositeData} value whose index is
|
||||
* <var>key</var>, or {@code null} if there is no value mapping
|
||||
* to <var>key</var>, in this {@code TabularData} instance.
|
||||
*
|
||||
* @param key the key of the row to return.
|
||||
*
|
||||
* @return the value corresponding to <var>key</var>.
|
||||
*
|
||||
* @throws NullPointerException if the <var>key</var> is
|
||||
* <tt>null</tt>
|
||||
* {@code null}
|
||||
* @throws InvalidKeyException if the <var>key</var> does not
|
||||
* conform to this <tt>TabularData</tt> instance's *
|
||||
* <tt>TabularType</tt> definition
|
||||
* conform to this {@code TabularData} instance's *
|
||||
* {@code TabularType} definition
|
||||
*/
|
||||
public CompositeData get(Object[] key) ;
|
||||
|
||||
@ -146,45 +146,45 @@ public interface TabularData /*extends Map*/ {
|
||||
|
||||
|
||||
/**
|
||||
* Adds <var>value</var> to this <tt>TabularData</tt> instance.
|
||||
* Adds <var>value</var> to this {@code TabularData} instance.
|
||||
* The composite type of <var>value</var> must be the same as this
|
||||
* instance's row type (ie the composite type returned by
|
||||
* <tt>this.getTabularType().{@link TabularType#getRowType
|
||||
* getRowType()}</tt>), and there must not already be an existing
|
||||
* value in this <tt>TabularData</tt> instance whose index is the
|
||||
* <code>this.getTabularType().{@link TabularType#getRowType
|
||||
* getRowType()}</code>), and there must not already be an existing
|
||||
* value in this {@code TabularData} instance whose index is the
|
||||
* same as the one calculated for the <var>value</var> to be
|
||||
* added. The index for <var>value</var> is calculated according
|
||||
* to this <tt>TabularData</tt> instance's <tt>TabularType</tt>
|
||||
* definition (see <tt>TabularType.{@link
|
||||
* TabularType#getIndexNames getIndexNames()}</tt>).
|
||||
* to this {@code TabularData} instance's {@code TabularType}
|
||||
* definition (see <code>TabularType.{@link
|
||||
* TabularType#getIndexNames getIndexNames()}</code>).
|
||||
*
|
||||
* @param value the composite data value to be added as a new row to this <tt>TabularData</tt> instance;
|
||||
* @param value the composite data value to be added as a new row to this {@code TabularData} instance;
|
||||
* must be of the same composite type as this instance's row type;
|
||||
* must not be null.
|
||||
*
|
||||
* @throws NullPointerException if <var>value</var> is <tt>null</tt>
|
||||
* @throws InvalidOpenTypeException if <var>value</var> does not conform to this <tt>TabularData</tt> instance's
|
||||
* @throws NullPointerException if <var>value</var> is {@code null}
|
||||
* @throws InvalidOpenTypeException if <var>value</var> does not conform to this {@code TabularData} instance's
|
||||
* row type definition.
|
||||
* @throws KeyAlreadyExistsException if the index for <var>value</var>, calculated according to
|
||||
* this <tt>TabularData</tt> instance's <tt>TabularType</tt> definition
|
||||
* this {@code TabularData} instance's {@code TabularType} definition
|
||||
* already maps to an existing value in the underlying HashMap.
|
||||
*/
|
||||
public void put(CompositeData value) ;
|
||||
|
||||
/**
|
||||
* Removes the <tt>CompositeData</tt> value whose index is <var>key</var> from this <tt>TabularData</tt> instance,
|
||||
* and returns the removed value, or returns <tt>null</tt> if there is no value whose index is <var>key</var>.
|
||||
* Removes the {@code CompositeData} value whose index is <var>key</var> from this {@code TabularData} instance,
|
||||
* and returns the removed value, or returns {@code null} if there is no value whose index is <var>key</var>.
|
||||
*
|
||||
* @param key the index of the value to get in this <tt>TabularData</tt> instance;
|
||||
* must be valid with this <tt>TabularData</tt> instance's row type definition;
|
||||
* @param key the index of the value to get in this {@code TabularData} instance;
|
||||
* must be valid with this {@code TabularData} instance's row type definition;
|
||||
* must not be null.
|
||||
*
|
||||
* @return previous value associated with specified key, or <tt>null</tt>
|
||||
* @return previous value associated with specified key, or {@code null}
|
||||
* if there was no mapping for key.
|
||||
*
|
||||
* @throws NullPointerException if the <var>key</var> is <tt>null</tt>
|
||||
* @throws InvalidKeyException if the <var>key</var> does not conform to this <tt>TabularData</tt> instance's
|
||||
* <tt>TabularType</tt> definition
|
||||
* @throws NullPointerException if the <var>key</var> is {@code null}
|
||||
* @throws InvalidKeyException if the <var>key</var> does not conform to this {@code TabularData} instance's
|
||||
* {@code TabularType} definition
|
||||
*/
|
||||
public CompositeData remove(Object[] key) ;
|
||||
|
||||
@ -195,27 +195,27 @@ public interface TabularData /*extends Map*/ {
|
||||
|
||||
|
||||
/**
|
||||
* Add all the elements in <var>values</var> to this <tt>TabularData</tt> instance.
|
||||
* If any element in <var>values</var> does not satisfy the constraints defined in {@link #put(CompositeData) <tt>put</tt>},
|
||||
* or if any two elements in <var>values</var> have the same index calculated according to this <tt>TabularData</tt>
|
||||
* instance's <tt>TabularType</tt> definition, then an exception describing the failure is thrown
|
||||
* and no element of <var>values</var> is added, thus leaving this <tt>TabularData</tt> instance unchanged.
|
||||
* Add all the elements in <var>values</var> to this {@code TabularData} instance.
|
||||
* If any element in <var>values</var> does not satisfy the constraints defined in {@link #put(CompositeData) put},
|
||||
* or if any two elements in <var>values</var> have the same index calculated according to this {@code TabularData}
|
||||
* instance's {@code TabularType} definition, then an exception describing the failure is thrown
|
||||
* and no element of <var>values</var> is added, thus leaving this {@code TabularData} instance unchanged.
|
||||
*
|
||||
* @param values the array of composite data values to be added as new rows to this <tt>TabularData</tt> instance;
|
||||
* if <var>values</var> is <tt>null</tt> or empty, this method returns without doing anything.
|
||||
* @param values the array of composite data values to be added as new rows to this {@code TabularData} instance;
|
||||
* if <var>values</var> is {@code null} or empty, this method returns without doing anything.
|
||||
*
|
||||
* @throws NullPointerException if an element of <var>values</var> is <tt>null</tt>
|
||||
* @throws NullPointerException if an element of <var>values</var> is {@code null}
|
||||
* @throws InvalidOpenTypeException if an element of <var>values</var> does not conform to
|
||||
* this <tt>TabularData</tt> instance's row type definition
|
||||
* this {@code TabularData} instance's row type definition
|
||||
* @throws KeyAlreadyExistsException if the index for an element of <var>values</var>, calculated according to
|
||||
* this <tt>TabularData</tt> instance's <tt>TabularType</tt> definition
|
||||
* this {@code TabularData} instance's {@code TabularType} definition
|
||||
* already maps to an existing value in this instance,
|
||||
* or two elements of <var>values</var> have the same index.
|
||||
*/
|
||||
public void putAll(CompositeData[] values) ;
|
||||
|
||||
/**
|
||||
* Removes all <tt>CompositeData</tt> values (ie rows) from this <tt>TabularData</tt> instance.
|
||||
* Removes all {@code CompositeData} values (ie rows) from this {@code TabularData} instance.
|
||||
*/
|
||||
public void clear();
|
||||
|
||||
@ -257,47 +257,47 @@ public interface TabularData /*extends Map*/ {
|
||||
|
||||
|
||||
/**
|
||||
* Compares the specified <var>obj</var> parameter with this <code>TabularData</code> instance for equality.
|
||||
* Compares the specified <var>obj</var> parameter with this {@code TabularData} instance for equality.
|
||||
* <p>
|
||||
* Returns <tt>true</tt> if and only if all of the following statements are true:
|
||||
* Returns {@code true} if and only if all of the following statements are true:
|
||||
* <ul>
|
||||
* <li><var>obj</var> is non null,</li>
|
||||
* <li><var>obj</var> also implements the <code>TabularData</code> interface,</li>
|
||||
* <li><var>obj</var> also implements the {@code TabularData} interface,</li>
|
||||
* <li>their row types are equal</li>
|
||||
* <li>their contents (ie index to value mappings) are equal</li>
|
||||
* </ul>
|
||||
* This ensures that this <tt>equals</tt> method works properly for <var>obj</var> parameters which are
|
||||
* different implementations of the <code>TabularData</code> interface.
|
||||
* This ensures that this {@code equals} method works properly for <var>obj</var> parameters which are
|
||||
* different implementations of the {@code TabularData} interface.
|
||||
* <br>
|
||||
* @param obj the object to be compared for equality with this <code>TabularData</code> instance;
|
||||
* @param obj the object to be compared for equality with this {@code TabularData} instance;
|
||||
*
|
||||
* @return <code>true</code> if the specified object is equal to this <code>TabularData</code> instance.
|
||||
* @return {@code true} if the specified object is equal to this {@code TabularData} instance.
|
||||
*/
|
||||
public boolean equals(Object obj);
|
||||
|
||||
/**
|
||||
* Returns the hash code value for this <code>TabularData</code> instance.
|
||||
* Returns the hash code value for this {@code TabularData} instance.
|
||||
* <p>
|
||||
* The hash code of a <code>TabularData</code> instance is the sum of the hash codes
|
||||
* of all elements of information used in <code>equals</code> comparisons
|
||||
* The hash code of a {@code TabularData} instance is the sum of the hash codes
|
||||
* of all elements of information used in {@code equals} comparisons
|
||||
* (ie: its <i>tabular type</i> and its content, where the content is defined as all the index to value mappings).
|
||||
* <p>
|
||||
* This ensures that <code> t1.equals(t2) </code> implies that <code> t1.hashCode()==t2.hashCode() </code>
|
||||
* for any two <code>TabularDataSupport</code> instances <code>t1</code> and <code>t2</code>,
|
||||
* This ensures that {@code t1.equals(t2)} implies that {@code t1.hashCode()==t2.hashCode()}
|
||||
* for any two {@code TabularDataSupport} instances {@code t1} and {@code t2},
|
||||
* as required by the general contract of the method
|
||||
* {@link Object#hashCode() Object.hashCode()}.
|
||||
*
|
||||
* @return the hash code value for this <code>TabularDataSupport</code> instance
|
||||
* @return the hash code value for this {@code TabularDataSupport} instance
|
||||
*/
|
||||
public int hashCode();
|
||||
|
||||
/**
|
||||
* Returns a string representation of this <code>TabularData</code> instance.
|
||||
* Returns a string representation of this {@code TabularData} instance.
|
||||
* <p>
|
||||
* The string representation consists of the name of the implementing class,
|
||||
* and the tabular type of this instance.
|
||||
*
|
||||
* @return a string representation of this <code>TabularData</code> instance
|
||||
* @return a string representation of this {@code TabularData} instance
|
||||
*/
|
||||
public String toString();
|
||||
|
||||
|
@ -51,8 +51,9 @@ import java.util.Set;
|
||||
|
||||
|
||||
/**
|
||||
* The <tt>TabularDataSupport</tt> class is the <i>open data</i> class which implements the <tt>TabularData</tt>
|
||||
* and the <tt>Map</tt> interfaces, and which is internally based on a hash map data structure.
|
||||
* The {@code TabularDataSupport} class is the <i>open data</i>
|
||||
* class which implements the {@code TabularData}
|
||||
* and the {@code Map} interfaces, and which is internally based on a hash map data structure.
|
||||
*
|
||||
* @since 1.5
|
||||
*/
|
||||
@ -102,13 +103,15 @@ public class TabularDataSupport
|
||||
|
||||
|
||||
/**
|
||||
* Creates an empty <tt>TabularDataSupport</tt> instance whose open-type is <var>tabularType</var>,
|
||||
* and whose underlying <tt>HashMap</tt> has a default initial capacity (101) and default load factor (0.75).
|
||||
* Creates an empty {@code TabularDataSupport} instance
|
||||
* whose open-type is <var>tabularType</var>,
|
||||
* and whose underlying {@code HashMap} has a default
|
||||
* initial capacity (101) and default load factor (0.75).
|
||||
* <p>
|
||||
* This constructor simply calls <tt>this(tabularType, 101, 0.75f);</tt>
|
||||
* This constructor simply calls {@code this(tabularType, 101, 0.75f);}
|
||||
*
|
||||
* @param tabularType the <i>tabular type</i> describing this <tt>TabularData</tt> instance;
|
||||
* cannot be null.
|
||||
* @param tabularType the <i>tabular type</i> describing this
|
||||
* {@code TabularData} instance; cannot be null.
|
||||
*
|
||||
* @throws IllegalArgumentException if the tabular type is null.
|
||||
*/
|
||||
@ -118,10 +121,10 @@ public class TabularDataSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an empty <tt>TabularDataSupport</tt> instance whose open-type is <var>tabularType</var>,
|
||||
* and whose underlying <tt>HashMap</tt> has the specified initial capacity and load factor.
|
||||
* Creates an empty {@code TabularDataSupport} instance whose open-type is <var>tabularType</var>,
|
||||
* and whose underlying {@code HashMap} has the specified initial capacity and load factor.
|
||||
*
|
||||
* @param tabularType the <i>tabular type</i> describing this <tt>TabularData</tt> instance;
|
||||
* @param tabularType the <i>tabular type</i> describing this {@code TabularData} instance;
|
||||
* cannot be null.
|
||||
*
|
||||
* @param initialCapacity the initial capacity of the HashMap.
|
||||
@ -167,7 +170,7 @@ public class TabularDataSupport
|
||||
|
||||
|
||||
/**
|
||||
* Returns the <i>tabular type</i> describing this <tt>TabularData</tt> instance.
|
||||
* Returns the <i>tabular type</i> describing this {@code TabularData} instance.
|
||||
*/
|
||||
public TabularType getTabularType() {
|
||||
|
||||
@ -175,21 +178,22 @@ public class TabularDataSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculates the index that would be used in this <tt>TabularData</tt> instance to refer to the specified
|
||||
* composite data <var>value</var> parameter if it were added to this instance.
|
||||
* Calculates the index that would be used in this {@code TabularData} instance to refer
|
||||
* to the specified composite data <var>value</var> parameter if it were added to this instance.
|
||||
* This method checks for the type validity of the specified <var>value</var>,
|
||||
* but does not check if the calculated index is already used to refer to a value in this <tt>TabularData</tt> instance.
|
||||
* but does not check if the calculated index is already used
|
||||
* to refer to a value in this {@code TabularData} instance.
|
||||
*
|
||||
* @param value the composite data value whose index in this
|
||||
* <tt>TabularData</tt> instance is to be calculated;
|
||||
* {@code TabularData} instance is to be calculated;
|
||||
* must be of the same composite type as this instance's row type;
|
||||
* must not be null.
|
||||
*
|
||||
* @return the index that the specified <var>value</var> would have in this <tt>TabularData</tt> instance.
|
||||
* @return the index that the specified <var>value</var> would have in this {@code TabularData} instance.
|
||||
*
|
||||
* @throws NullPointerException if <var>value</var> is <tt>null</tt>.
|
||||
* @throws NullPointerException if <var>value</var> is {@code null}.
|
||||
*
|
||||
* @throws InvalidOpenTypeException if <var>value</var> does not conform to this <tt>TabularData</tt> instance's
|
||||
* @throws InvalidOpenTypeException if <var>value</var> does not conform to this {@code TabularData} instance's
|
||||
* row type definition.
|
||||
*/
|
||||
public Object[] calculateIndex(CompositeData value) {
|
||||
@ -210,14 +214,14 @@ public class TabularDataSupport
|
||||
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if and only if this <tt>TabularData</tt> instance contains a <tt>CompositeData</tt> value
|
||||
* Returns {@code true} if and only if this {@code TabularData} instance contains a {@code CompositeData} value
|
||||
* (ie a row) whose index is the specified <var>key</var>. If <var>key</var> cannot be cast to a one dimension array
|
||||
* of Object instances, this method simply returns <tt>false</tt>; otherwise it returns the result of the call to
|
||||
* <tt>this.containsKey((Object[]) key)</tt>.
|
||||
* of Object instances, this method simply returns {@code false}; otherwise it returns the result of the call to
|
||||
* {@code this.containsKey((Object[]) key)}.
|
||||
*
|
||||
* @param key the index value whose presence in this <tt>TabularData</tt> instance is to be tested.
|
||||
* @param key the index value whose presence in this {@code TabularData} instance is to be tested.
|
||||
*
|
||||
* @return <tt>true</tt> if this <tt>TabularData</tt> indexes a row value with the specified key.
|
||||
* @return {@code true} if this {@code TabularData} indexes a row value with the specified key.
|
||||
*/
|
||||
public boolean containsKey(Object key) {
|
||||
|
||||
@ -234,13 +238,13 @@ public class TabularDataSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if and only if this <tt>TabularData</tt> instance contains a <tt>CompositeData</tt> value
|
||||
* (ie a row) whose index is the specified <var>key</var>. If <var>key</var> is <tt>null</tt> or does not conform to
|
||||
* this <tt>TabularData</tt> instance's <tt>TabularType</tt> definition, this method simply returns <tt>false</tt>.
|
||||
* Returns {@code true} if and only if this {@code TabularData} instance contains a {@code CompositeData} value
|
||||
* (ie a row) whose index is the specified <var>key</var>. If <var>key</var> is {@code null} or does not conform to
|
||||
* this {@code TabularData} instance's {@code TabularType} definition, this method simply returns {@code false}.
|
||||
*
|
||||
* @param key the index value whose presence in this <tt>TabularData</tt> instance is to be tested.
|
||||
* @param key the index value whose presence in this {@code TabularData} instance is to be tested.
|
||||
*
|
||||
* @return <tt>true</tt> if this <tt>TabularData</tt> indexes a row value with the specified key.
|
||||
* @return {@code true} if this {@code TabularData} indexes a row value with the specified key.
|
||||
*/
|
||||
public boolean containsKey(Object[] key) {
|
||||
|
||||
@ -248,13 +252,13 @@ public class TabularDataSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if and only if this <tt>TabularData</tt> instance contains the specified
|
||||
* <tt>CompositeData</tt> value. If <var>value</var> is <tt>null</tt> or does not conform to
|
||||
* this <tt>TabularData</tt> instance's row type definition, this method simply returns <tt>false</tt>.
|
||||
* Returns {@code true} if and only if this {@code TabularData} instance contains the specified
|
||||
* {@code CompositeData} value. If <var>value</var> is {@code null} or does not conform to
|
||||
* this {@code TabularData} instance's row type definition, this method simply returns {@code false}.
|
||||
*
|
||||
* @param value the row value whose presence in this <tt>TabularData</tt> instance is to be tested.
|
||||
* @param value the row value whose presence in this {@code TabularData} instance is to be tested.
|
||||
*
|
||||
* @return <tt>true</tt> if this <tt>TabularData</tt> instance contains the specified row value.
|
||||
* @return {@code true} if this {@code TabularData} instance contains the specified row value.
|
||||
*/
|
||||
public boolean containsValue(CompositeData value) {
|
||||
|
||||
@ -262,12 +266,12 @@ public class TabularDataSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if and only if this <tt>TabularData</tt> instance contains the specified
|
||||
* Returns {@code true} if and only if this {@code TabularData} instance contains the specified
|
||||
* value.
|
||||
*
|
||||
* @param value the row value whose presence in this <tt>TabularData</tt> instance is to be tested.
|
||||
* @param value the row value whose presence in this {@code TabularData} instance is to be tested.
|
||||
*
|
||||
* @return <tt>true</tt> if this <tt>TabularData</tt> instance contains the specified row value.
|
||||
* @return {@code true} if this {@code TabularData} instance contains the specified row value.
|
||||
*/
|
||||
public boolean containsValue(Object value) {
|
||||
|
||||
@ -275,12 +279,13 @@ public class TabularDataSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* This method simply calls <tt>get((Object[]) key)</tt>.
|
||||
* This method simply calls {@code get((Object[]) key)}.
|
||||
*
|
||||
* @throws NullPointerException if the <var>key</var> is <tt>null</tt>
|
||||
* @throws ClassCastException if the <var>key</var> is not of the type <tt>Object[]</tt>
|
||||
* @throws InvalidKeyException if the <var>key</var> does not conform to this <tt>TabularData</tt> instance's
|
||||
* <tt>TabularType</tt> definition
|
||||
* @throws NullPointerException if the <var>key</var> is {@code null}
|
||||
* @throws ClassCastException if the <var>key</var> is not of the type {@code Object[]}
|
||||
* @throws InvalidKeyException if the <var>key</var> does not conform
|
||||
* to this {@code TabularData} instance's
|
||||
* {@code TabularType} definition
|
||||
*/
|
||||
public Object get(Object key) {
|
||||
|
||||
@ -288,20 +293,21 @@ public class TabularDataSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the <tt>CompositeData</tt> value whose index is
|
||||
* <var>key</var>, or <tt>null</tt> if there is no value mapping
|
||||
* to <var>key</var>, in this <tt>TabularData</tt> instance.
|
||||
* Returns the {@code CompositeData} value whose index is
|
||||
* <var>key</var>, or {@code null} if there is no value mapping
|
||||
* to <var>key</var>, in this {@code TabularData} instance.
|
||||
*
|
||||
* @param key the index of the value to get in this
|
||||
* <tt>TabularData</tt> instance; * must be valid with this
|
||||
* <tt>TabularData</tt> instance's row type definition; * must not
|
||||
* {@code TabularData} instance; must be valid with this
|
||||
* {@code TabularData} instance's row type definition; must not
|
||||
* be null.
|
||||
*
|
||||
* @return the value corresponding to <var>key</var>.
|
||||
*
|
||||
* @throws NullPointerException if the <var>key</var> is <tt>null</tt>
|
||||
* @throws InvalidKeyException if the <var>key</var> does not conform to this <tt>TabularData</tt> instance's
|
||||
* <tt>TabularType</tt> type definition.
|
||||
* @throws NullPointerException if the <var>key</var> is {@code null}
|
||||
* @throws InvalidKeyException if the <var>key</var> does not conform
|
||||
* to this {@code TabularData} instance's
|
||||
* {@code TabularType} type definition.
|
||||
*/
|
||||
public CompositeData get(Object[] key) {
|
||||
|
||||
@ -322,23 +328,23 @@ public class TabularDataSupport
|
||||
|
||||
|
||||
/**
|
||||
* This method simply calls <tt>put((CompositeData) value)</tt> and
|
||||
* therefore ignores its <var>key</var> parameter which can be <tt>null</tt>.
|
||||
* This method simply calls {@code put((CompositeData) value)} and
|
||||
* therefore ignores its <var>key</var> parameter which can be {@code null}.
|
||||
*
|
||||
* @param key an ignored parameter.
|
||||
* @param value the {@link CompositeData} to put.
|
||||
*
|
||||
* @return the value which is put
|
||||
*
|
||||
* @throws NullPointerException if the <var>value</var> is <tt>null</tt>
|
||||
* @throws NullPointerException if the <var>value</var> is {@code null}
|
||||
* @throws ClassCastException if the <var>value</var> is not of
|
||||
* the type <tt>CompositeData</tt>
|
||||
* the type {@code CompositeData}
|
||||
* @throws InvalidOpenTypeException if the <var>value</var> does
|
||||
* not conform to this <tt>TabularData</tt> instance's
|
||||
* <tt>TabularType</tt> definition
|
||||
* not conform to this {@code TabularData} instance's
|
||||
* {@code TabularType} definition
|
||||
* @throws KeyAlreadyExistsException if the key for the
|
||||
* <var>value</var> parameter, calculated according to this
|
||||
* <tt>TabularData</tt> instance's <tt>TabularType</tt> definition
|
||||
* {@code TabularData} instance's {@code TabularType} definition
|
||||
* already maps to an existing value
|
||||
*/
|
||||
public Object put(Object key, Object value) {
|
||||
@ -363,17 +369,17 @@ public class TabularDataSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* This method simply calls <tt>remove((Object[]) key)</tt>.
|
||||
* This method simply calls {@code remove((Object[]) key)}.
|
||||
*
|
||||
* @param key an <tt>Object[]</tt> representing the key to remove.
|
||||
* @param key an {@code Object[]} representing the key to remove.
|
||||
*
|
||||
* @return previous value associated with specified key, or <tt>null</tt>
|
||||
* @return previous value associated with specified key, or {@code null}
|
||||
* if there was no mapping for key.
|
||||
*
|
||||
* @throws NullPointerException if the <var>key</var> is <tt>null</tt>
|
||||
* @throws ClassCastException if the <var>key</var> is not of the type <tt>Object[]</tt>
|
||||
* @throws InvalidKeyException if the <var>key</var> does not conform to this <tt>TabularData</tt> instance's
|
||||
* <tt>TabularType</tt> definition
|
||||
* @throws NullPointerException if the <var>key</var> is {@code null}
|
||||
* @throws ClassCastException if the <var>key</var> is not of the type {@code Object[]}
|
||||
* @throws InvalidKeyException if the <var>key</var> does not conform to this {@code TabularData} instance's
|
||||
* {@code TabularType} definition
|
||||
*/
|
||||
public Object remove(Object key) {
|
||||
|
||||
@ -381,19 +387,19 @@ public class TabularDataSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes the <tt>CompositeData</tt> value whose index is <var>key</var> from this <tt>TabularData</tt> instance,
|
||||
* and returns the removed value, or returns <tt>null</tt> if there is no value whose index is <var>key</var>.
|
||||
* Removes the {@code CompositeData} value whose index is <var>key</var> from this {@code TabularData} instance,
|
||||
* and returns the removed value, or returns {@code null} if there is no value whose index is <var>key</var>.
|
||||
*
|
||||
* @param key the index of the value to get in this <tt>TabularData</tt> instance;
|
||||
* must be valid with this <tt>TabularData</tt> instance's row type definition;
|
||||
* @param key the index of the value to get in this {@code TabularData} instance;
|
||||
* must be valid with this {@code TabularData} instance's row type definition;
|
||||
* must not be null.
|
||||
*
|
||||
* @return previous value associated with specified key, or <tt>null</tt>
|
||||
* @return previous value associated with specified key, or {@code null}
|
||||
* if there was no mapping for key.
|
||||
*
|
||||
* @throws NullPointerException if the <var>key</var> is <tt>null</tt>
|
||||
* @throws InvalidKeyException if the <var>key</var> does not conform to this <tt>TabularData</tt> instance's
|
||||
* <tt>TabularType</tt> definition
|
||||
* @throws NullPointerException if the <var>key</var> is {@code null}
|
||||
* @throws InvalidKeyException if the <var>key</var> does not conform to this {@code TabularData} instance's
|
||||
* {@code TabularType} definition
|
||||
*/
|
||||
public CompositeData remove(Object[] key) {
|
||||
|
||||
@ -414,30 +420,30 @@ public class TabularDataSupport
|
||||
|
||||
/**
|
||||
* Add all the values contained in the specified map <var>t</var>
|
||||
* to this <tt>TabularData</tt> instance. This method converts
|
||||
* to this {@code TabularData} instance. This method converts
|
||||
* the collection of values contained in this map into an array of
|
||||
* <tt>CompositeData</tt> values, if possible, and then call the
|
||||
* method <tt>putAll(CompositeData[])</tt>. Note that the keys
|
||||
* {@code CompositeData} values, if possible, and then call the
|
||||
* method {@code putAll(CompositeData[])}. Note that the keys
|
||||
* used in the specified map <var>t</var> are ignored. This method
|
||||
* allows, for example to add the content of another
|
||||
* <tt>TabularData</tt> instance with the same row type (but
|
||||
* {@code TabularData} instance with the same row type (but
|
||||
* possibly different index names) into this instance.
|
||||
*
|
||||
* @param t the map whose values are to be added as new rows to
|
||||
* this <tt>TabularData</tt> instance; if <var>t</var> is
|
||||
* <tt>null</tt> or empty, this method returns without doing
|
||||
* this {@code TabularData} instance; if <var>t</var> is
|
||||
* {@code null} or empty, this method returns without doing
|
||||
* anything.
|
||||
*
|
||||
* @throws NullPointerException if a value in <var>t</var> is
|
||||
* <tt>null</tt>.
|
||||
* {@code null}.
|
||||
* @throws ClassCastException if a value in <var>t</var> is not an
|
||||
* instance of <tt>CompositeData</tt>.
|
||||
* instance of {@code CompositeData}.
|
||||
* @throws InvalidOpenTypeException if a value in <var>t</var>
|
||||
* does not conform to this <tt>TabularData</tt> instance's row
|
||||
* does not conform to this {@code TabularData} instance's row
|
||||
* type definition.
|
||||
* @throws KeyAlreadyExistsException if the index for a value in
|
||||
* <var>t</var>, calculated according to this
|
||||
* <tt>TabularData</tt> instance's <tt>TabularType</tt> definition
|
||||
* {@code TabularData} instance's {@code TabularType} definition
|
||||
* already maps to an existing value in this instance, or two
|
||||
* values in <var>t</var> have the same index.
|
||||
*/
|
||||
@ -449,14 +455,14 @@ public class TabularDataSupport
|
||||
return;
|
||||
}
|
||||
|
||||
// Convert the values in t into an array of <tt>CompositeData</tt>
|
||||
// Convert the values in t into an array of {@code CompositeData}
|
||||
//
|
||||
CompositeData[] values;
|
||||
try {
|
||||
values =
|
||||
t.values().toArray(new CompositeData[t.size()]);
|
||||
} catch (java.lang.ArrayStoreException e) {
|
||||
throw new ClassCastException("Map argument t contains values which are not instances of <tt>CompositeData</tt>");
|
||||
throw new ClassCastException("Map argument t contains values which are not instances of {@code CompositeData}");
|
||||
}
|
||||
|
||||
// Add the array of values
|
||||
@ -466,30 +472,30 @@ public class TabularDataSupport
|
||||
|
||||
/**
|
||||
* Add all the elements in <var>values</var> to this
|
||||
* <tt>TabularData</tt> instance. If any element in
|
||||
* {@code TabularData} instance. If any element in
|
||||
* <var>values</var> does not satisfy the constraints defined in
|
||||
* {@link #put(CompositeData) <tt>put</tt>}, or if any two
|
||||
* {@link #put(CompositeData) put}, or if any two
|
||||
* elements in <var>values</var> have the same index calculated
|
||||
* according to this <tt>TabularData</tt> instance's
|
||||
* <tt>TabularType</tt> definition, then an exception describing
|
||||
* according to this {@code TabularData} instance's
|
||||
* {@code TabularType} definition, then an exception describing
|
||||
* the failure is thrown and no element of <var>values</var> is
|
||||
* added, thus leaving this <tt>TabularData</tt> instance
|
||||
* added, thus leaving this {@code TabularData} instance
|
||||
* unchanged.
|
||||
*
|
||||
* @param values the array of composite data values to be added as
|
||||
* new rows to this <tt>TabularData</tt> instance; if
|
||||
* <var>values</var> is <tt>null</tt> or empty, this method
|
||||
* new rows to this {@code TabularData} instance; if
|
||||
* <var>values</var> is {@code null} or empty, this method
|
||||
* returns without doing anything.
|
||||
*
|
||||
* @throws NullPointerException if an element of <var>values</var>
|
||||
* is <tt>null</tt>
|
||||
* is {@code null}
|
||||
* @throws InvalidOpenTypeException if an element of
|
||||
* <var>values</var> does not conform to this
|
||||
* <tt>TabularData</tt> instance's row type definition (ie its
|
||||
* <tt>TabularType</tt> definition)
|
||||
* {@code TabularData} instance's row type definition (ie its
|
||||
* {@code TabularType} definition)
|
||||
* @throws KeyAlreadyExistsException if the index for an element
|
||||
* of <var>values</var>, calculated according to this
|
||||
* <tt>TabularData</tt> instance's <tt>TabularType</tt> definition
|
||||
* {@code TabularData} instance's {@code TabularType} definition
|
||||
* already maps to an existing value in this instance, or two
|
||||
* elements of <var>values</var> have the same index
|
||||
*/
|
||||
@ -529,7 +535,7 @@ public class TabularDataSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes all rows from this <code>TabularDataSupport</code> instance.
|
||||
* Removes all rows from this {@code TabularDataSupport} instance.
|
||||
*/
|
||||
public void clear() {
|
||||
|
||||
@ -541,9 +547,9 @@ public class TabularDataSupport
|
||||
/* *** Informational methods from java.util.Map *** */
|
||||
|
||||
/**
|
||||
* Returns the number of rows in this <code>TabularDataSupport</code> instance.
|
||||
* Returns the number of rows in this {@code TabularDataSupport} instance.
|
||||
*
|
||||
* @return the number of rows in this <code>TabularDataSupport</code> instance.
|
||||
* @return the number of rows in this {@code TabularDataSupport} instance.
|
||||
*/
|
||||
public int size() {
|
||||
|
||||
@ -551,9 +557,9 @@ public class TabularDataSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if this <code>TabularDataSupport</code> instance contains no rows.
|
||||
* Returns {@code true} if this {@code TabularDataSupport} instance contains no rows.
|
||||
*
|
||||
* @return <tt>true</tt> if this <code>TabularDataSupport</code> instance contains no rows.
|
||||
* @return {@code true} if this {@code TabularDataSupport} instance contains no rows.
|
||||
*/
|
||||
public boolean isEmpty() {
|
||||
|
||||
@ -656,9 +662,10 @@ public class TabularDataSupport
|
||||
|
||||
|
||||
/**
|
||||
* Returns a clone of this <code>TabularDataSupport</code> instance:
|
||||
* the clone is obtained by calling <tt>super.clone()</tt>, and then cloning the underlying map.
|
||||
* Only a shallow clone of the underlying map is made, i.e. no cloning of the indexes and row values is made as they are immutable.
|
||||
* Returns a clone of this {@code TabularDataSupport} instance:
|
||||
* the clone is obtained by calling {@code super.clone()}, and then cloning the underlying map.
|
||||
* Only a shallow clone of the underlying map is made, i.e.
|
||||
* no cloning of the indexes and row values is made as they are immutable.
|
||||
*/
|
||||
/* We cannot use covariance here and return TabularDataSupport
|
||||
because this would fail with existing code that subclassed
|
||||
@ -677,21 +684,21 @@ public class TabularDataSupport
|
||||
|
||||
|
||||
/**
|
||||
* Compares the specified <var>obj</var> parameter with this <code>TabularDataSupport</code> instance for equality.
|
||||
* Compares the specified <var>obj</var> parameter with this {@code TabularDataSupport} instance for equality.
|
||||
* <p>
|
||||
* Returns <tt>true</tt> if and only if all of the following statements are true:
|
||||
* Returns {@code true} if and only if all of the following statements are true:
|
||||
* <ul>
|
||||
* <li><var>obj</var> is non null,</li>
|
||||
* <li><var>obj</var> also implements the <code>TabularData</code> interface,</li>
|
||||
* <li><var>obj</var> also implements the {@code TabularData} interface,</li>
|
||||
* <li>their tabular types are equal</li>
|
||||
* <li>their contents (ie all CompositeData values) are equal.</li>
|
||||
* </ul>
|
||||
* This ensures that this <tt>equals</tt> method works properly for <var>obj</var> parameters which are
|
||||
* different implementations of the <code>TabularData</code> interface.
|
||||
* This ensures that this {@code equals} method works properly for <var>obj</var> parameters which are
|
||||
* different implementations of the {@code TabularData} interface.
|
||||
* <br>
|
||||
* @param obj the object to be compared for equality with this <code>TabularDataSupport</code> instance;
|
||||
* @param obj the object to be compared for equality with this {@code TabularDataSupport} instance;
|
||||
*
|
||||
* @return <code>true</code> if the specified object is equal to this <code>TabularDataSupport</code> instance.
|
||||
* @return {@code true} if the specified object is equal to this {@code TabularDataSupport} instance.
|
||||
*/
|
||||
public boolean equals(Object obj) {
|
||||
|
||||
@ -738,22 +745,22 @@ public class TabularDataSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the hash code value for this <code>TabularDataSupport</code> instance.
|
||||
* Returns the hash code value for this {@code TabularDataSupport} instance.
|
||||
* <p>
|
||||
* The hash code of a <code>TabularDataSupport</code> instance is the sum of the hash codes
|
||||
* of all elements of information used in <code>equals</code> comparisons
|
||||
* The hash code of a {@code TabularDataSupport} instance is the sum of the hash codes
|
||||
* of all elements of information used in {@code equals} comparisons
|
||||
* (ie: its <i>tabular type</i> and its content, where the content is defined as all the CompositeData values).
|
||||
* <p>
|
||||
* This ensures that <code> t1.equals(t2) </code> implies that <code> t1.hashCode()==t2.hashCode() </code>
|
||||
* for any two <code>TabularDataSupport</code> instances <code>t1</code> and <code>t2</code>,
|
||||
* This ensures that {@code t1.equals(t2)} implies that {@code t1.hashCode()==t2.hashCode()}
|
||||
* for any two {@code TabularDataSupport} instances {@code t1} and {@code t2},
|
||||
* as required by the general contract of the method
|
||||
* {@link Object#hashCode() Object.hashCode()}.
|
||||
* <p>
|
||||
* However, note that another instance of a class implementing the <code>TabularData</code> interface
|
||||
* may be equal to this <code>TabularDataSupport</code> instance as defined by {@link #equals},
|
||||
* However, note that another instance of a class implementing the {@code TabularData} interface
|
||||
* may be equal to this {@code TabularDataSupport} instance as defined by {@link #equals},
|
||||
* but may have a different hash code if it is calculated differently.
|
||||
*
|
||||
* @return the hash code value for this <code>TabularDataSupport</code> instance
|
||||
* @return the hash code value for this {@code TabularDataSupport} instance
|
||||
*/
|
||||
public int hashCode() {
|
||||
|
||||
@ -768,14 +775,15 @@ public class TabularDataSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a string representation of this <code>TabularDataSupport</code> instance.
|
||||
* Returns a string representation of this {@code TabularDataSupport} instance.
|
||||
* <p>
|
||||
* The string representation consists of the name of this class (ie <code>javax.management.openmbean.TabularDataSupport</code>),
|
||||
* The string representation consists of the name of this class
|
||||
* (ie {@code javax.management.openmbean.TabularDataSupport}),
|
||||
* the string representation of the tabular type of this instance, and the string representation of the contents
|
||||
* (ie list the key=value mappings as returned by a call to
|
||||
* <tt>dataMap.</tt>{@link java.util.HashMap#toString() toString()}).
|
||||
* {@code dataMap.}{@link java.util.HashMap#toString() toString()}).
|
||||
*
|
||||
* @return a string representation of this <code>TabularDataSupport</code> instance
|
||||
* @return a string representation of this {@code TabularDataSupport} instance
|
||||
*/
|
||||
public String toString() {
|
||||
|
||||
@ -796,14 +804,17 @@ public class TabularDataSupport
|
||||
|
||||
|
||||
/**
|
||||
* Returns the index for value, assuming value is valid for this <tt>TabularData</tt> instance
|
||||
* Returns the index for value, assuming value is valid for this {@code TabularData} instance
|
||||
* (ie value is not null, and its composite type is equal to row type).
|
||||
*
|
||||
* The index is a List, and not an array, so that an index.equals(otherIndex) call will actually compare contents,
|
||||
* The index is a List, and not an array, so that an
|
||||
* index.equals(otherIndex) call will actually compare contents,
|
||||
* not just the objects references as is done for an array object.
|
||||
*
|
||||
* The returned List is unmodifiable so that once a row has been put into the dataMap, its index cannot be modified,
|
||||
* for example by a user that would attempt to modify an index contained in the Set returned by keySet().
|
||||
* The returned List is unmodifiable so that once a row has been put
|
||||
* into the dataMap, its index cannot be modified,
|
||||
* for example by a user that would attempt to modify an
|
||||
* index contained in the Set returned by keySet().
|
||||
*/
|
||||
private List<?> internalCalculateIndex(CompositeData value) {
|
||||
|
||||
@ -811,7 +822,7 @@ public class TabularDataSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the specified key is valid for this <tt>TabularData</tt> instance.
|
||||
* Checks if the specified key is valid for this {@code TabularData} instance.
|
||||
*
|
||||
* @throws NullPointerException
|
||||
* @throws InvalidOpenTypeException
|
||||
@ -848,7 +859,7 @@ public class TabularDataSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks the specified value's type is valid for this <tt>TabularData</tt> instance
|
||||
* Checks the specified value's type is valid for this {@code TabularData} instance
|
||||
* (ie value is not null, and its composite type is equal to row type).
|
||||
*
|
||||
* @throws NullPointerException
|
||||
@ -872,7 +883,7 @@ public class TabularDataSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the specified value can be put (ie added) in this <tt>TabularData</tt> instance
|
||||
* Checks if the specified value can be put (ie added) in this {@code TabularData} instance
|
||||
* (ie value is not null, its composite type is equal to row type, and its index is not already used),
|
||||
* and returns the index calculated for this value.
|
||||
*
|
||||
|
@ -42,7 +42,7 @@ import javax.management.NotCompliantMBeanException;
|
||||
/**
|
||||
* A RoleInfo object summarises a role in a relation type.
|
||||
*
|
||||
* <p>The <b>serialVersionUID</b> of this class is <code>2504952983494636987L</code>.
|
||||
* <p>The <b>serialVersionUID</b> of this class is {@code 2504952983494636987L}.
|
||||
*
|
||||
* @since 1.5
|
||||
*/
|
||||
@ -89,8 +89,8 @@ public class RoleInfo implements Serializable {
|
||||
private static final long serialVersionUID;
|
||||
/**
|
||||
* @serialField name String Role name
|
||||
* @serialField isReadable boolean Read access mode: <code>true</code> if role is readable
|
||||
* @serialField isWritable boolean Write access mode: <code>true</code> if role is writable
|
||||
* @serialField isReadable boolean Read access mode: {@code true} if role is readable
|
||||
* @serialField isWritable boolean Write access mode: {@code true} if role is writable
|
||||
* @serialField description String Role description
|
||||
* @serialField minDegree int Minimum degree (i.e. minimum number of referenced MBeans in corresponding role)
|
||||
* @serialField maxDegree int Maximum degree (i.e. maximum number of referenced MBeans in corresponding role)
|
||||
@ -136,12 +136,12 @@ public class RoleInfo implements Serializable {
|
||||
private String name = null;
|
||||
|
||||
/**
|
||||
* @serial Read access mode: <code>true</code> if role is readable
|
||||
* @serial Read access mode: {@code true} if role is readable
|
||||
*/
|
||||
private boolean isReadable;
|
||||
|
||||
/**
|
||||
* @serial Write access mode: <code>true</code> if role is writable
|
||||
* @serial Write access mode: {@code true} if role is writable
|
||||
*/
|
||||
private boolean isWritable;
|
||||
|
||||
@ -183,11 +183,11 @@ public class RoleInfo implements Serializable {
|
||||
* can be set
|
||||
* @param min minimum degree for role, i.e. minimum number of
|
||||
* MBeans to provide in corresponding role
|
||||
* Must be less than or equal to <tt>max</tt>.
|
||||
* Must be less than or equal to {@code max}.
|
||||
* (ROLE_CARDINALITY_INFINITY for unlimited)
|
||||
* @param max maximum degree for role, i.e. maximum number of
|
||||
* MBeans to provide in corresponding role
|
||||
* Must be greater than or equal to <tt>min</tt>
|
||||
* Must be greater than or equal to {@code min}
|
||||
* (ROLE_CARDINALITY_INFINITY for unlimited)
|
||||
* @param descr description of the role (can be null)
|
||||
*
|
||||
@ -316,7 +316,7 @@ public class RoleInfo implements Serializable {
|
||||
/**
|
||||
* Copy constructor.
|
||||
*
|
||||
* @param roleInfo the <tt>RoleInfo</tt> instance to be copied.
|
||||
* @param roleInfo the {@code RoleInfo} instance to be copied.
|
||||
*
|
||||
* @exception IllegalArgumentException if null parameter
|
||||
*/
|
||||
@ -413,7 +413,7 @@ public class RoleInfo implements Serializable {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if the <tt>value</tt> parameter is greater than or equal to
|
||||
* Returns true if the {@code value} parameter is greater than or equal to
|
||||
* the expected minimum degree, false otherwise.
|
||||
*
|
||||
* @param value the value to be checked
|
||||
@ -431,7 +431,7 @@ public class RoleInfo implements Serializable {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if the <tt>value</tt> parameter is lower than or equal to
|
||||
* Returns true if the {@code value} parameter is lower than or equal to
|
||||
* the expected maximum degree, false otherwise.
|
||||
*
|
||||
* @param value the value to be checked
|
||||
|
@ -142,7 +142,7 @@ public class RMIConnector implements JMXConnector, Serializable, JMXAddressable
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>Constructs an <code>RMIConnector</code> that will connect
|
||||
* <p>Constructs an {@code RMIConnector} that will connect
|
||||
* the RMI connector server with the given address.</p>
|
||||
*
|
||||
* <p>The address can refer directly to the connector server,
|
||||
@ -153,7 +153,7 @@ public class RMIConnector implements JMXConnector, Serializable, JMXAddressable
|
||||
* service:jmx:iiop://<em>[host[:port]]</em>/ior/<em>encoded-IOR</em>
|
||||
* </pre>
|
||||
*
|
||||
* <p>(Here, the square brackets <code>[]</code> are not part of the
|
||||
* <p>(Here, the square brackets {@code []} are not part of the
|
||||
* address but indicate that the host and port are optional.)</p>
|
||||
*
|
||||
* <p>The address can instead indicate where to find an RMI stub
|
||||
@ -179,7 +179,7 @@ public class RMIConnector implements JMXConnector, Serializable, JMXAddressable
|
||||
* InitialContext#InitialContext(Hashtable) InitialContext}. This
|
||||
* parameter can be null, which is equivalent to an empty Map.
|
||||
*
|
||||
* @exception IllegalArgumentException if <code>url</code>
|
||||
* @exception IllegalArgumentException if {@code url}
|
||||
* is null.
|
||||
*/
|
||||
public RMIConnector(JMXServiceURL url, Map<String,?> environment) {
|
||||
@ -187,14 +187,14 @@ public class RMIConnector implements JMXConnector, Serializable, JMXAddressable
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>Constructs an <code>RMIConnector</code> using the given RMI stub.
|
||||
* <p>Constructs an {@code RMIConnector} using the given RMI stub.
|
||||
*
|
||||
* @param rmiServer an RMI stub representing the RMI connector server.
|
||||
* @param environment additional attributes specifying how to make
|
||||
* the connection. This parameter can be null, which is
|
||||
* equivalent to an empty Map.
|
||||
*
|
||||
* @exception IllegalArgumentException if <code>rmiServer</code>
|
||||
* @exception IllegalArgumentException if {@code rmiServer}
|
||||
* is null.
|
||||
*/
|
||||
public RMIConnector(RMIServer rmiServer, Map<String,?> environment) {
|
||||
@ -203,7 +203,7 @@ public class RMIConnector implements JMXConnector, Serializable, JMXAddressable
|
||||
|
||||
/**
|
||||
* <p>Returns a string representation of this object. In general,
|
||||
* the <code>toString</code> method returns a string that
|
||||
* the {@code 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.</p>
|
||||
@ -1732,7 +1732,7 @@ public class RMIConnector implements JMXConnector, Serializable, JMXAddressable
|
||||
* @param environment An environment map, possibly containing an ORB.
|
||||
* @return the given stub.
|
||||
* @exception IllegalArgumentException if the
|
||||
* <tt>java.naming.corba.orb</tt> property is specified and
|
||||
* {@code java.naming.corba.orb} property is specified and
|
||||
* does not point to an {@link org.omg.CORBA.ORB ORB}.
|
||||
* @exception IOException if the connection to the ORB failed.
|
||||
**/
|
||||
@ -1767,7 +1767,7 @@ public class RMIConnector implements JMXConnector, Serializable, JMXAddressable
|
||||
* @param environment An environment map, possibly containing an ORB.
|
||||
* @return An ORB.
|
||||
* @exception IllegalArgumentException if the
|
||||
* <tt>java.naming.corba.orb</tt> property is specified and
|
||||
* {@code java.naming.corba.orb} property is specified and
|
||||
* does not point to an {@link org.omg.CORBA.ORB ORB}.
|
||||
* @exception IOException if the ORB initialization failed.
|
||||
**/
|
||||
@ -1793,7 +1793,7 @@ public class RMIConnector implements JMXConnector, Serializable, JMXAddressable
|
||||
/**
|
||||
* Read RMIConnector fields from an {@link java.io.ObjectInputStream
|
||||
* ObjectInputStream}.
|
||||
* Calls <code>s.defaultReadObject()</code> and then initializes
|
||||
* Calls {@code s.defaultReadObject()} and then initializes
|
||||
* all transient variables that need initializing.
|
||||
* @param s The ObjectInputStream to read from.
|
||||
* @exception InvalidObjectException if none of <var>rmiServer</var> stub
|
||||
@ -1818,7 +1818,7 @@ public class RMIConnector implements JMXConnector, Serializable, JMXAddressable
|
||||
* before serializing it. This is done using the environment
|
||||
* map that was provided to the constructor, if any, and as documented
|
||||
* in {@link javax.management.remote.rmi}.</p>
|
||||
* <p>This method then calls <code>s.defaultWriteObject()</code>.
|
||||
* <p>This method then calls {@code s.defaultWriteObject()}.
|
||||
* Usually, <var>rmiServer</var> is null if this object
|
||||
* was constructed with a JMXServiceURL, and <var>jmxServiceURL</var>
|
||||
* is null if this object is constructed with a RMIServer stub.
|
||||
@ -1939,9 +1939,9 @@ public class RMIConnector implements JMXConnector, Serializable, JMXAddressable
|
||||
* Lookup the RMIServer stub in a directory.
|
||||
* @param jndiURL A JNDI URL indicating the location of the Stub
|
||||
* (see {@link javax.management.remote.rmi}), e.g.:
|
||||
* <ul><li><tt>rmi://registry-host:port/rmi-stub-name</tt></li>
|
||||
* <li>or <tt>iiop://cosnaming-host:port/iiop-stub-name</tt></li>
|
||||
* <li>or <tt>ldap://ldap-host:port/java-container-dn</tt></li>
|
||||
* <ul><li>{@code rmi://registry-host:port/rmi-stub-name}</li>
|
||||
* <li>or {@code iiop://cosnaming-host:port/iiop-stub-name}</li>
|
||||
* <li>or {@code ldap://ldap-host:port/java-container-dn}</li>
|
||||
* </ul>
|
||||
* @param env the environment Map passed to the connector.
|
||||
* @param isIiop true if the stub is expected to be an IIOP stub.
|
||||
|
Loading…
x
Reference in New Issue
Block a user