<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_40) on Fri Oct 18 06:47:25 UTC 2013 -->
<title>I18NStandardMBean (MX4J API)</title>
<meta name="date" content="2013-10-18">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="I18NStandardMBean (MX4J API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/I18NStandardMBean.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?mx4j/tools/i18n/I18NStandardMBean.html" target="_top">Frames</a></li>
<li><a href="I18NStandardMBean.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">mx4j.tools.i18n</div>
<h2 title="Class I18NStandardMBean" class="title">Class I18NStandardMBean</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>javax.management.StandardMBean</li>
<li>
<ul class="inheritance">
<li>mx4j.tools.i18n.I18NStandardMBean</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>javax.management.DynamicMBean</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">I18NStandardMBean</span>
extends javax.management.StandardMBean</pre>
<div class="block">An extension of StandardMBean to support internationalization. <p>
<p/>
The I18N information is taken from a property bundle named MyImplMBeanResources
where "MyImpl" is the fully qualified class implementing the MBean. <p>
These bundles are nested following the class hierachy of the <b>implementation</b>
class. This means that a superclass of the real implementing class can
define the resource bundle for the common attributes and operations.
<p/>
The resource bundle naming rules defined by <code>ResourceBundle</code>
are used; in particular : <UL>
<LI>If a <b>class</b> called MyPackage.MyImplMBeanResources_localInfo exists it is used (programmatic methd)
<LI>Otherwise the <b>file</b> called MyPackage.MyImplMBeanResources_localInfo.properties is used.
</UL>
<p/>
localInfo consists of one or more sections of "language_country_variant" (eg en_GB or fr_FR).
<p/>
The locale to be used is determined by one of the following mechanisms (in this order) <UL>
<LI>The locale object explicitly passed to the constructor (if not null)
<LI>The static method <a href="../../../mx4j/tools/i18n/I18NStandardMBean.html#setDefaultLocale(java.util.Locale)"><code>setDefaultLocale(java.util.Locale)</code></a>
<LI>The system property "mx4j.descriptionLocale"
<LI>The current system default locale
</UL>
<p/>
The bundle should contain keys as described below :
<H2>Global bean description</H2>
The global bean description is given by the single key "descr": <pre>
descr=The MBean Description
</pre>
<p/>
<H2>Attributes</H2>
Attribute desciptions are given by keys of form "attr.Name" where Name
is the attribute name (the method name minus the get/set prefix) : <pre>
attr.Counter=The counter
</pre>
<p/>
<H2>Constructors</H2>
<H3>Non ambiguous case</H3>
All constructors having a different <b>number</b> of arguments may be described in this way: <pre>
cons.N=desciption of constructor N
cons.N.param.1=Description of first parameter of constructor N
cons.N.paramName.1=paramName1
cons.N.param.2=Description of first parameter of constructor N
cons.N.paramName.2=paramName2
</pre>
Where N is a sequential number starting at one.
<p/>
<H3>Ambiguous case</H3>
Where several constructors exist with the same number of arguments an explicit
signature must be given. The signature is a comma separated list of class descriptions
(as returned by <code>Class.getName()</code> and has the key cons.N.sig : <pre>
cons.N.sig=int,java.lang.Object
cons.N.param.1=The int parameter
cons.N.param.2=The Object parameter
</pre>
<p/>
<H2>Operations</H2>
<H3>No overloading</H3>
When no overloaded versions of an operation exist (same method name but different parameters)
the simplest case shown below can be used : <pre>
op.<I>operationName</I>=The description
op.<I>operationName</I>.param.1=The first parameter
op.<I>operationName</I>.paramName.1=param1
</pre>
<p/>
<H3>Non ambiguous overloading case</H3>
When operation overloading is used but the overloaded versions differ in the number
of parameters the format below can be used : <pre>
op.<I>operationName</I>.1=The first version of operationName
op.<I>operationName</I>.1.param.1=parameter for first version
op.<I>operationName</I>.1.paramName.1=param1
op.<I>operationName</I>.2=The second version of operationName
op.<I>operationName</I>.2.paramName.1=param1
op.<I>operationName</I>.2.param.1=first parameter for second version
op.<I>operationName</I>.2.param.2=second parameter for second version
op.<I>operationName</I>.2.paramName.2=param2
</pre>
<p/>
<H3>Ambiguous overloading case</H3>
When operations with the same name have the same number of arguments an explicit
signature must be used : <pre>
op.<I>operationName</I>.1.sig=int
op.<I>operationName</I>.1=The first version of operationName (takes int)
op.<I>operationName</I>.1.param.1=parameter for first version
op.<I>operationName</I>.1.paramName.1=param1
op.<I>operationName</I>.2.sig=java.lang.Object
op.<I>operationName</I>.2=The second version of operationName (take Object)
op.<I>operationName</I>.2.paramName.1=param1
op.<I>operationName</I>.2.param.1=first parameter for second version
</pre>
<p/>
<H2>Restrictions</H2>
Parameter names must only contain characters allowed in a Java identifier
(in particular spaces are <b>not</b> allowed). This is required by the JMX specifications.
No such restrictions exist for the other descriptions.
<p/>
<H2>Behaviour with missing data</H2>
If no resource bunde exists for the MBean a java.util.MissingResourceException
will be thrown by the constructor. <p>
<p/>
If the resouce bundle is found but the bean description, constructor description or
parameter name is missing the String "??(key)" will be returned instead (eg
"??(op.myOperation)". <p>
<p/>
If a paramName key is missing (for constructor or operation) the version normally
given by StandardMBean is used (generally "pN").<p>
<p/>
If a non ambiguous description cannot be determined the fixed (non translatable)
descriptions "ambiguous constructor", "parameter for ambiguous constructor",
"ambiguous operation", "parameter for ambiguous operation" are returned.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/i18n/I18NStandardMBean.html#I18NStandardMBean(java.lang.Class)">I18NStandardMBean</a></strong>(java.lang.Class mbeanInterface)</code>
<div class="block">Makes a I18NStandardMBean for the default locale implemented by a subclass.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/i18n/I18NStandardMBean.html#I18NStandardMBean(java.lang.Class, java.util.Locale)">I18NStandardMBean</a></strong>(java.lang.Class mbeanInterface,
java.util.Locale locale)</code>
<div class="block">Makes a I18NStandardMBean for the given locale implemented by a subclass.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code> </code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/i18n/I18NStandardMBean.html#I18NStandardMBean(java.lang.Object, java.lang.Class)">I18NStandardMBean</a></strong>(java.lang.Object implementation,
java.lang.Class mbeanInterface)</code>
<div class="block">Makes an I18NStandardMBean for the default locale with a separate implementation class.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code> </code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/i18n/I18NStandardMBean.html#I18NStandardMBean(java.lang.Object, java.lang.Class, java.util.Locale)">I18NStandardMBean</a></strong>(java.lang.Object implementation,
java.lang.Class mbeanInterface,
java.util.Locale locale)</code>
<div class="block">Makes an I18NStandardMBean for the given locale with a separate implementation class.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/i18n/I18NStandardMBean.html#cacheMBeanInfo(javax.management.MBeanInfo)">cacheMBeanInfo</a></strong>(javax.management.MBeanInfo info)</code>
<div class="block">Once the MBeanInfo has been obtained discard our caches.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected javax.management.MBeanInfo</code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/i18n/I18NStandardMBean.html#getCachedMBeanInfo()">getCachedMBeanInfo</a></strong>()</code>
<div class="block">Initialise internal data structures.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected javax.management.MBeanConstructorInfo[]</code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/i18n/I18NStandardMBean.html#getConstructors(javax.management.MBeanConstructorInfo[], java.lang.Object)">getConstructors</a></strong>(javax.management.MBeanConstructorInfo[] cstrs,
java.lang.Object impl)</code>
<div class="block">Returns, by default, the given <code>constructors</code> if <code>implementation</code>
is 'this' object or null, otherwise returns null.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/i18n/I18NStandardMBean.html#getDescription(javax.management.MBeanAttributeInfo)">getDescription</a></strong>(javax.management.MBeanAttributeInfo attr)</code>
<div class="block">Obtain the attribute description.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/i18n/I18NStandardMBean.html#getDescription(javax.management.MBeanConstructorInfo)">getDescription</a></strong>(javax.management.MBeanConstructorInfo cstr)</code>
<div class="block">Obtain the constructor description.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/i18n/I18NStandardMBean.html#getDescription(javax.management.MBeanConstructorInfo, javax.management.MBeanParameterInfo, int)">getDescription</a></strong>(javax.management.MBeanConstructorInfo cstr,
javax.management.MBeanParameterInfo param,
int seq)</code>
<div class="block">Obtain the constructor parameter description.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/i18n/I18NStandardMBean.html#getDescription(javax.management.MBeanInfo)">getDescription</a></strong>(javax.management.MBeanInfo info)</code>
<div class="block">Obtain global description for MBean.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/i18n/I18NStandardMBean.html#getDescription(javax.management.MBeanOperationInfo)">getDescription</a></strong>(javax.management.MBeanOperationInfo op)</code>
<div class="block">Obtain the operation description.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/i18n/I18NStandardMBean.html#getDescription(javax.management.MBeanOperationInfo, javax.management.MBeanParameterInfo, int)">getDescription</a></strong>(javax.management.MBeanOperationInfo op,
javax.management.MBeanParameterInfo param,
int seq)</code>
<div class="block">Obtain the operation parameter description.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/i18n/I18NStandardMBean.html#getParameterName(javax.management.MBeanConstructorInfo, javax.management.MBeanParameterInfo, int)">getParameterName</a></strong>(javax.management.MBeanConstructorInfo cstr,
javax.management.MBeanParameterInfo param,
int seq)</code>
<div class="block">Obtain constructor parameter name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/i18n/I18NStandardMBean.html#getParameterName(javax.management.MBeanOperationInfo, javax.management.MBeanParameterInfo, int)">getParameterName</a></strong>(javax.management.MBeanOperationInfo op,
javax.management.MBeanParameterInfo param,
int seq)</code>
<div class="block">Obtain operation parameter name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/i18n/I18NStandardMBean.html#setDefaultLocale(java.util.Locale)">setDefaultLocale</a></strong>(java.util.Locale locale)</code>
<div class="block">Set the locale which will be used for future I18NStandardMBeans.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_javax.management.StandardMBean">
<!-- -->
</a>
<h3>Methods inherited from class javax.management.StandardMBean</h3>
<code>getAttribute, getAttributes, getClassName, getDescription, getImpact, getImplementation, getImplementationClass, getMBeanInfo, getMBeanInterface, invoke, setAttribute, setAttributes, setImplementation</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="I18NStandardMBean(java.lang.Object, java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>I18NStandardMBean</h4>
<pre>public I18NStandardMBean(java.lang.Object implementation,
java.lang.Class mbeanInterface)
throws javax.management.NotCompliantMBeanException</pre>
<div class="block">Makes an I18NStandardMBean for the default locale with a separate implementation class.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>javax.management.NotCompliantMBeanException</code></dd><dt><span class="strong">See Also:</span></dt><dd><code>StandardMBean.StandardMBean(java.lang.Object, java.lang.Class)</code></dd></dl>
</li>
</ul>
<a name="I18NStandardMBean(java.lang.Object, java.lang.Class, java.util.Locale)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>I18NStandardMBean</h4>
<pre>public I18NStandardMBean(java.lang.Object implementation,
java.lang.Class mbeanInterface,
java.util.Locale locale)
throws javax.management.NotCompliantMBeanException</pre>
<div class="block">Makes an I18NStandardMBean for the given locale with a separate implementation class.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>javax.management.NotCompliantMBeanException</code></dd><dt><span class="strong">See Also:</span></dt><dd><code>StandardMBean.StandardMBean(java.lang.Object, java.lang.Class)</code></dd></dl>
</li>
</ul>
<a name="I18NStandardMBean(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>I18NStandardMBean</h4>
<pre>protected I18NStandardMBean(java.lang.Class mbeanInterface)
throws javax.management.NotCompliantMBeanException</pre>
<div class="block">Makes a I18NStandardMBean for the default locale implemented by a subclass.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>javax.management.NotCompliantMBeanException</code></dd><dt><span class="strong">See Also:</span></dt><dd><code>StandardMBean.StandardMBean(java.lang.Class)</code></dd></dl>
</li>
</ul>
<a name="I18NStandardMBean(java.lang.Class, java.util.Locale)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>I18NStandardMBean</h4>
<pre>protected I18NStandardMBean(java.lang.Class mbeanInterface,
java.util.Locale locale)
throws javax.management.NotCompliantMBeanException</pre>
<div class="block">Makes a I18NStandardMBean for the given locale implemented by a subclass.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>javax.management.NotCompliantMBeanException</code></dd><dt><span class="strong">See Also:</span></dt><dd><code>StandardMBean.StandardMBean(java.lang.Class)</code></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setDefaultLocale(java.util.Locale)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDefaultLocale</h4>
<pre>public static void setDefaultLocale(java.util.Locale locale)</pre>
<div class="block">Set the locale which will be used for future I18NStandardMBeans. <p>
The locale specified can be overridden on a per class basis via the
constructors but overrides other means of setting the Locale (system properties). <p>
<p/>
Changing the locale has no effect on already constructed MBeans.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locale</code> - the Locale for future MBeans</dd></dl>
</li>
</ul>
<a name="getCachedMBeanInfo()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCachedMBeanInfo</h4>
<pre>protected javax.management.MBeanInfo getCachedMBeanInfo()</pre>
<div class="block">Initialise internal data structures. <p>
This method is always called first during getMBeanInfo processing.
We use this to avoid keeping all our internal Maps in memory too long.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>getCachedMBeanInfo</code> in class <code>javax.management.StandardMBean</code></dd>
<dt><span class="strong">See Also:</span></dt><dd><code>StandardMBean.getCachedMBeanInfo()</code></dd></dl>
</li>
</ul>
<a name="cacheMBeanInfo(javax.management.MBeanInfo)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cacheMBeanInfo</h4>
<pre>protected void cacheMBeanInfo(javax.management.MBeanInfo info)</pre>
<div class="block">Once the MBeanInfo has been obtained discard our caches.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>cacheMBeanInfo</code> in class <code>javax.management.StandardMBean</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>info</code> - The MBeanInfo to cache; if it is null, the cache is cleared.</dd><dt><span class="strong">See Also:</span></dt><dd><code>StandardMBean.cacheMBeanInfo(javax.management.MBeanInfo)</code></dd></dl>
</li>
</ul>
<a name="getConstructors(javax.management.MBeanConstructorInfo[], java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConstructors</h4>
<pre>protected javax.management.MBeanConstructorInfo[] getConstructors(javax.management.MBeanConstructorInfo[] cstrs,
java.lang.Object impl)</pre>
<div class="block"><strong>Description copied from class: <code>javax.management.StandardMBean</code></strong></div>
<div class="block">Returns, by default, the given <code>constructors</code> if <code>implementation</code>
is 'this' object or null, otherwise returns null. <br>
Since the MBean that is registered in an MBeanServer is always an instance of StandardMBean,
there is no meaning in providing MBeanConstructorInfo if the implementation passed to
<code>StandardMBean.StandardMBean(Object,Class)</code> is not 'this' object.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>getConstructors</code> in class <code>javax.management.StandardMBean</code></dd>
</dl>
</li>
</ul>
<a name="getDescription(javax.management.MBeanInfo)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescription</h4>
<pre>protected java.lang.String getDescription(javax.management.MBeanInfo info)</pre>
<div class="block">Obtain global description for MBean. <p>
Taken from "descr" key in resource bundle. <p>
<p/>
Also performs internal initialisations requiring the MBeanInfo obtained
by introspection. Therefore the superclass must call this method BEFORE
the other hooks.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>getDescription</code> in class <code>javax.management.StandardMBean</code></dd>
<dt><span class="strong">See Also:</span></dt><dd><code>StandardMBean.getDescription(javax.management.MBeanInfo)</code></dd></dl>
</li>
</ul>
<a name="getDescription(javax.management.MBeanConstructorInfo)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescription</h4>
<pre>protected java.lang.String getDescription(javax.management.MBeanConstructorInfo cstr)</pre>
<div class="block">Obtain the constructor description. <p>
Taken from "cons.N" key in resource bundle. <p>
<p/>
Maybe "ambiguous constructor" if correct index cannot be determined by
an explicit signature or parameter counts.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>getDescription</code> in class <code>javax.management.StandardMBean</code></dd>
<dt><span class="strong">See Also:</span></dt><dd><code>StandardMBean.getDescription(javax.management.MBeanConstructorInfo)</code></dd></dl>
</li>
</ul>
<a name="getDescription(javax.management.MBeanConstructorInfo, javax.management.MBeanParameterInfo, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescription</h4>
<pre>protected java.lang.String getDescription(javax.management.MBeanConstructorInfo cstr,
javax.management.MBeanParameterInfo param,
int seq)</pre>
<div class="block">Obtain the constructor parameter description. <p>
Taken from "cons.N.param.<I>seq</I>" key in resource bundle. <p>
<p/>
Maybe "parameter for ambiguous constructor" if correct index cannot be determined by
an explicit signature or parameter counts.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>getDescription</code> in class <code>javax.management.StandardMBean</code></dd>
<dt><span class="strong">See Also:</span></dt><dd><code>StandardMBean.getDescription(javax.management.MBeanConstructorInfo, javax.management.MBeanParameterInfo, int)</code></dd></dl>
</li>
</ul>
<a name="getParameterName(javax.management.MBeanConstructorInfo, javax.management.MBeanParameterInfo, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameterName</h4>
<pre>protected java.lang.String getParameterName(javax.management.MBeanConstructorInfo cstr,
javax.management.MBeanParameterInfo param,
int seq)</pre>
<div class="block">Obtain constructor parameter name. <p>
Taken from "cons.N.paramName.<I>seq</I>" key in resource bundle. <p>
<p/>
If this key does not exist or if the correct index N cannot be determined by
an explicit signature or parameter counts the superclass method is called.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>getParameterName</code> in class <code>javax.management.StandardMBean</code></dd>
<dt><span class="strong">See Also:</span></dt><dd><code>StandardMBean.getParameterName(javax.management.MBeanConstructorInfo, javax.management.MBeanParameterInfo, int)</code></dd></dl>
</li>
</ul>
<a name="getDescription(javax.management.MBeanAttributeInfo)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescription</h4>
<pre>protected java.lang.String getDescription(javax.management.MBeanAttributeInfo attr)</pre>
<div class="block">Obtain the attribute description. <p>
Taken from the "attr.<I>attributeName</I>" key in resource bundle.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>getDescription</code> in class <code>javax.management.StandardMBean</code></dd>
<dt><span class="strong">See Also:</span></dt><dd><code>StandardMBean.getDescription(javax.management.MBeanAttributeInfo)</code></dd></dl>
</li>
</ul>
<a name="getDescription(javax.management.MBeanOperationInfo)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescription</h4>
<pre>protected java.lang.String getDescription(javax.management.MBeanOperationInfo op)</pre>
<div class="block">Obtain the operation description. <p>
Taken from the "op.<I>operationName</I>.N" or the "op.<I>operationName</I>"
key in the resource bundle. <p>
May be "ambiguous operation" if the correct key cannot be determined by
signature or parameter counts.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>getDescription</code> in class <code>javax.management.StandardMBean</code></dd>
<dt><span class="strong">See Also:</span></dt><dd><code>StandardMBean.getDescription(javax.management.MBeanOperationInfo)</code></dd></dl>
</li>
</ul>
<a name="getDescription(javax.management.MBeanOperationInfo, javax.management.MBeanParameterInfo, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescription</h4>
<pre>protected java.lang.String getDescription(javax.management.MBeanOperationInfo op,
javax.management.MBeanParameterInfo param,
int seq)</pre>
<div class="block">Obtain the operation parameter description. <p>
Taken from the "op.<I>operationName</I>.N.param.M" or the "op.<I>operationName</I>.param"
key in the resource bundle. <p>
May be "parameter for ambiguous operation" if the correct key cannot be determined by
signature or parameter counts.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>getDescription</code> in class <code>javax.management.StandardMBean</code></dd>
<dt><span class="strong">See Also:</span></dt><dd><code>StandardMBean.getDescription(javax.management.MBeanOperationInfo, javax.management.MBeanParameterInfo, int)</code></dd></dl>
</li>
</ul>
<a name="getParameterName(javax.management.MBeanOperationInfo, javax.management.MBeanParameterInfo, int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getParameterName</h4>
<pre>protected java.lang.String getParameterName(javax.management.MBeanOperationInfo op,
javax.management.MBeanParameterInfo param,
int seq)</pre>
<div class="block">Obtain operation parameter name. <p>
Taken from the "op.<I>operationName</I>.N.paramName.M" or the "op.<I>operationName.paramName</I>.M"
key in the resource bundle. <p>
<p/>
If this key does not exist or if the correct index N cannot be determined by
an explicit signature or parameter counts the superclass method is called.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>getParameterName</code> in class <code>javax.management.StandardMBean</code></dd>
<dt><span class="strong">See Also:</span></dt><dd><code>StandardMBean.getParameterName(javax.management.MBeanOperationInfo, javax.management.MBeanParameterInfo, int)</code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/I18NStandardMBean.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?mx4j/tools/i18n/I18NStandardMBean.html" target="_top">Frames</a></li>
<li><a href="I18NStandardMBean.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><center><small>Copyright © 2001-2005 The MX4J Contributors. All Rights Reserved.</small></center></small></p>
</body>
</html>
