/usr/share/doc/libosgi-compendium-java/api/org/osgi/jmx/Item.html is in libosgi-compendium-java-doc 4.3.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_23) on Mon Nov 21 22:05:28 UTC 2011 -->
<TITLE>
Item
</TITLE>
<META NAME="date" CONTENT="2011-11-21">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Item";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../org/osgi/jmx/JmxConstants.html" title="class in org.osgi.jmx"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?org/osgi/jmx/Item.html" target="_top"><B>FRAMES</B></A>
<A HREF="Item.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.osgi.jmx</FONT>
<BR>
Class Item</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.osgi.jmx.Item</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>Item</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
The item class enables the definition of open types in the appropriate
interfaces.
This class contains a number of methods that make it possible to create open
types for <CODE>CompositeType</CODE>, <CODE>TabularType</CODE>, and <CODE>ArrayType</CODE>.
The normal creation throws a checked exception, making it impossible to use
them in a static initializer. The constructors are also not very suitable
for static construction.
An Item instance describes an item in a Composite Type. It groups the triplet
of name, description, and Open Type. These Item instances allows the
definitions of an item to stay together.
<P>
<P>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../org/osgi/jmx/Item.html#Item(java.lang.String, java.lang.String, javax.management.openmbean.OpenType, java.lang.String...)">Item</A></B>(java.lang.String name,
java.lang.String description,
javax.management.openmbean.OpenType type,
java.lang.String... restrictions)</CODE>
<BR>
Create a triple of name, description, and type.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static javax.management.openmbean.ArrayType</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/osgi/jmx/Item.html#arrayType(int, javax.management.openmbean.OpenType)">arrayType</A></B>(int dim,
javax.management.openmbean.OpenType elementType)</CODE>
<BR>
Return a new Array Type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static javax.management.openmbean.CompositeType</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/osgi/jmx/Item.html#compositeType(java.lang.String, java.lang.String, org.osgi.jmx.Item...)">compositeType</A></B>(java.lang.String name,
java.lang.String description,
<A HREF="../../../org/osgi/jmx/Item.html" title="class in org.osgi.jmx">Item</A>... items)</CODE>
<BR>
Create a Composite Type</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static javax.management.openmbean.CompositeType</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/osgi/jmx/Item.html#extend(javax.management.openmbean.CompositeType, java.lang.String, java.lang.String, org.osgi.jmx.Item...)">extend</A></B>(javax.management.openmbean.CompositeType parent,
java.lang.String name,
java.lang.String description,
<A HREF="../../../org/osgi/jmx/Item.html" title="class in org.osgi.jmx">Item</A>... items)</CODE>
<BR>
Extend a Composite Type by adding new items.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static javax.management.openmbean.TabularType</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/osgi/jmx/Item.html#tabularType(java.lang.String, java.lang.String, javax.management.openmbean.CompositeType, java.lang.String...)">tabularType</A></B>(java.lang.String name,
java.lang.String description,
javax.management.openmbean.CompositeType rowType,
java.lang.String... index)</CODE>
<BR>
Create a Tabular Type.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="Item(java.lang.String, java.lang.String, javax.management.openmbean.OpenType, java.lang.String...)"><!-- --></A><H3>
Item</H3>
<PRE>
public <B>Item</B>(java.lang.String name,
java.lang.String description,
javax.management.openmbean.OpenType type,
java.lang.String... restrictions)</PRE>
<DL>
<DD>Create a triple of name, description, and type. This triplet is used in
the creation of a Composite Type.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the item.<DD><CODE>description</CODE> - The description of the item.<DD><CODE>type</CODE> - The Open Type of this item.<DD><CODE>restrictions</CODE> - Ignored, contains list of restrictions</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="tabularType(java.lang.String, java.lang.String, javax.management.openmbean.CompositeType, java.lang.String...)"><!-- --></A><H3>
tabularType</H3>
<PRE>
public static javax.management.openmbean.TabularType <B>tabularType</B>(java.lang.String name,
java.lang.String description,
javax.management.openmbean.CompositeType rowType,
java.lang.String... index)</PRE>
<DL>
<DD>Create a Tabular Type.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the Tabular Type.<DD><CODE>description</CODE> - The description of the Tabular Type.<DD><CODE>rowType</CODE> - The Open Type for a row<DD><CODE>index</CODE> - The names of the items that form the index .
<DT><B>Returns:</B><DD>A new Tabular Type composed from the parameters.
<DT><B>Throws:</B>
<DD><CODE>java.lang.RuntimeException</CODE> - when the Tabular Type throws an OpenDataException</DL>
</DD>
</DL>
<HR>
<A NAME="compositeType(java.lang.String, java.lang.String, org.osgi.jmx.Item...)"><!-- --></A><H3>
compositeType</H3>
<PRE>
public static javax.management.openmbean.CompositeType <B>compositeType</B>(java.lang.String name,
java.lang.String description,
<A HREF="../../../org/osgi/jmx/Item.html" title="class in org.osgi.jmx">Item</A>... items)</PRE>
<DL>
<DD>Create a Composite Type
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the Tabular Type.<DD><CODE>description</CODE> - The description of the Tabular Type.<DD><CODE>items</CODE> - The items that describe the composite type.
<DT><B>Returns:</B><DD>a new Composite Type
<DT><B>Throws:</B>
<DD><CODE>java.lang.RuntimeException</CODE> - when the Tabular Type throws an OpenDataException</DL>
</DD>
</DL>
<HR>
<A NAME="arrayType(int, javax.management.openmbean.OpenType)"><!-- --></A><H3>
arrayType</H3>
<PRE>
public static javax.management.openmbean.ArrayType <B>arrayType</B>(int dim,
javax.management.openmbean.OpenType elementType)</PRE>
<DL>
<DD>Return a new Array Type.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>dim</CODE> - The dimension<DD><CODE>elementType</CODE> - The element type
<DT><B>Returns:</B><DD>A new Array Type</DL>
</DD>
</DL>
<HR>
<A NAME="extend(javax.management.openmbean.CompositeType, java.lang.String, java.lang.String, org.osgi.jmx.Item...)"><!-- --></A><H3>
extend</H3>
<PRE>
public static javax.management.openmbean.CompositeType <B>extend</B>(javax.management.openmbean.CompositeType parent,
java.lang.String name,
java.lang.String description,
<A HREF="../../../org/osgi/jmx/Item.html" title="class in org.osgi.jmx">Item</A>... items)</PRE>
<DL>
<DD>Extend a Composite Type by adding new items. Items can override items in
the parent type.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>parent</CODE> - The parent type, can be <code>null</code><DD><CODE>name</CODE> - The name of the type<DD><CODE>description</CODE> - The description of the type<DD><CODE>items</CODE> - The items that should be added/override to the parent type
<DT><B>Returns:</B><DD>A new Composite Type that extends the parent type
<DT><B>Throws:</B>
<DD><CODE>java.lang.RuntimeException</CODE> - when an OpenDataException is thrown</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../org/osgi/jmx/JmxConstants.html" title="class in org.osgi.jmx"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?org/osgi/jmx/Item.html" target="_top"><B>FRAMES</B></A>
<A HREF="Item.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|