Java Doc for Descriptor.java in  » JMX » jfoxmx » javax » management » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » JMX » jfoxmx » javax.management 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


javax.management.Descriptor

All known Subclasses:   javax.management.modelmbean.DescriptorSupport,
Descriptor
public interface Descriptor extends Serializable(Code)
This interface represents the behavioral metadata set for a JMX Element. For examples, a descriptor is part of the ModelMBeanInfo, ModelMBeanNotificationInfo, ModelMBeanAttributeInfo, ModelMBeanConstructorInfo, and ModelMBeanParameterInfo.

A descriptor consists of a collection of fields. Each field is in fieldname=fieldvalue format.

All field names and values are not predefined. New fields can be defined and added by any program. In the case odf ModelMBean some fields have been predefined for consistency of implementation and support by the ModelMBeanInfo ModelMBean*Info, and ModelMBean classes.


author:
   Young Yang





Method Summary
public  Objectclone()
     Returns a new Descriptor which is a duplicate of the Descriptor.
public  String[]getFieldNames()
     Returns all the fields names in the descriptor. String array of fields names.
public  ObjectgetFieldValue(String fieldName)
     Returns the value for a specific fieldname.
Parameters:
  fieldName - The field name in question; if not found, null is returned.
public  Object[]getFieldValues(String[] fieldNames)
     Returns all the field values in the descriptor as an array of Objects.
public  String[]getFields()
     Returns all of the fields contained in this descriptor as a string array. String array of fields in the format fieldName=fieldValueIf the value of a field is not a String, then the toString() methodwill be called on it and the returned value used as the value forthe field in the returned array.
public  booleanisValid()
     Returns true if fieldValues are checked to be sure they are legal for the fieldNames.
public  voidremoveField(String fieldName)
    
public  voidsetField(String fieldName, Object fieldValue)
     Sets the value for a specific fieldname. The field value will be validated before it is set.
public  voidsetFields(String[] fieldNames, Object[] fieldValues)
     Sets all Fields in the list to the new value in with the same index in the fieldValue array.



Method Detail
clone
public Object clone() throws RuntimeOperationsException(Code)
Returns a new Descriptor which is a duplicate of the Descriptor.
exception:
  RuntimeOperationsException - for illegal value for field URLName or field Values.If the descriptor construction fails for any reason, this exception will be thrown.



getFieldNames
public String[] getFieldNames()(Code)
Returns all the fields names in the descriptor. String array of fields names. If the descriptor is empty, you will getan empty array.



getFieldValue
public Object getFieldValue(String fieldName) throws RuntimeOperationsException(Code)
Returns the value for a specific fieldname.
Parameters:
  fieldName - The field name in question; if not found, null is returned. Object Field value.
exception:
  RuntimeOperationsException - for illegal value for field name.



getFieldValues
public Object[] getFieldValues(String[] fieldNames)(Code)
Returns all the field values in the descriptor as an array of Objects. The retuned values are in the same order as the fieldNames String array parameter.
Parameters:
  fieldNames - String array of the names of the fields that the valuesshould be returned for. If the array is empty then an empty array will bereturned. If the array is 'null' then all values will be returned. If a fieldname in the array does not exist, then null is returned for the matching arrayelement being returned. Object array of field values. If the descriptor is empty, you will getan empty array.



getFields
public String[] getFields()(Code)
Returns all of the fields contained in this descriptor as a string array. String array of fields in the format fieldName=fieldValueIf the value of a field is not a String, then the toString() methodwill be called on it and the returned value used as the value forthe field in the returned array. Object values which are not Stringswill be enclosed in parens. If the descriptor is empty, you will getan empty array.



isValid
public boolean isValid() throws RuntimeOperationsException(Code)
Returns true if fieldValues are checked to be sure they are legal for the fieldNames.
exception:
  RuntimeOperationsException - If the validity checking fails for any reason, this exception will be thrown.



removeField
public void removeField(String fieldName)(Code)
Removes a field from the descriptor
Parameters:
  fieldName - String name of the field to be removed.If the field is not found no exception is thrown.



setField
public void setField(String fieldName, Object fieldValue) throws RuntimeOperationsException(Code)
Sets the value for a specific fieldname. The field value will be validated before it is set. If it is not valid, then an exception will be thrown. This will modify an existing field or add a new field. fieldName: The field name to be set. Cannot be null or empty. fieldValue: The field value to be set for the field name. Can be null.
exception:
  RuntimeOperationsException - for illegal value for field name or field value.



setFields
public void setFields(String[] fieldNames, Object[] fieldValues) throws RuntimeOperationsException(Code)
Sets all Fields in the list to the new value in with the same index in the fieldValue array. Array sizes must match. The field value will be validated before it is set. If it is not valid, then an exception will be thrown. If the arrays are empty, then no change will take effect.
Parameters:
  fieldNames - String array of field names. The array and array elements cannot be null.
Parameters:
  fieldValues - Object array of the corresponding field values. The array cannot be null.Elements of the array can be null.
exception:
  RuntimeOperationsException - for illegal value for field URLName or field Values.Niether can be null. The array lengths must be equal.If the descriptor construction fails for any reason, this exception will be thrown.



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.