/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/upnp/UPnPIcon.html is in libosgi-compendium-java-doc 5.0.0-5.
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 372 373 374 375 376 377 378 379 380 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<!-- Generated by javadoc -->
<title>UPnPIcon</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="UPnPIcon";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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="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><a href="../../../../org/osgi/service/upnp/UPnPException.html" title="class in org.osgi.service.upnp"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/upnp/UPnPLocalStateVariable.html" title="interface in org.osgi.service.upnp"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/upnp/UPnPIcon.html" target="_top">Frames</a></li>
<li><a href="UPnPIcon.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>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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">org.osgi.service.upnp</div>
<h2 title="Interface UPnPIcon" class="title">Interface UPnPIcon</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">UPnPIcon</span></pre>
<div class="block">A UPnP icon representation.
Each UPnP device can contain zero or more icons.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/upnp/UPnPIcon.html#getDepth--">getDepth</a></span>()</code>
<div class="block">Returns the color depth of the icon in bits.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/upnp/UPnPIcon.html#getHeight--">getHeight</a></span>()</code>
<div class="block">Returns the height of the icon in pixels.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.io.InputStream</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/upnp/UPnPIcon.html#getInputStream--">getInputStream</a></span>()</code>
<div class="block">Returns an <code>InputStream</code> object for the icon data.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/upnp/UPnPIcon.html#getMimeType--">getMimeType</a></span>()</code>
<div class="block">Returns the MIME type of the icon.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/upnp/UPnPIcon.html#getSize--">getSize</a></span>()</code>
<div class="block">Returns the size of the icon in bytes.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/upnp/UPnPIcon.html#getWidth--">getWidth</a></span>()</code>
<div class="block">Returns the width of the icon in pixels.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getMimeType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMimeType</h4>
<pre>java.lang.String getMimeType()</pre>
<div class="block">Returns the MIME type of the icon.
This method returns the format in which the icon graphics, read from the
<code>InputStream</code> object obtained by the <code>getInputStream()</code>
method, is encoded.
<p>
The format of the returned string is in accordance to RFC2046. A list of
valid MIME types is maintained by the <a
href="http://www.iana.org/assignments/media-types/">IANA</a>.
<p>
Typical values returned include: "image/jpeg" or "image/gif"
<p>
This method must continue to return the icon MIME type after the UPnP
device has been removed from the network.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The MIME type of the encoded icon.</dd>
</dl>
</li>
</ul>
<a name="getWidth--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWidth</h4>
<pre>int getWidth()</pre>
<div class="block">Returns the width of the icon in pixels.
If the actual width of the icon is unknown, -1 is returned.
<p>
This method must continue to return the icon width after the UPnP device
has been removed from the network.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The width in pixels, or -1 if unknown.</dd>
</dl>
</li>
</ul>
<a name="getHeight--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeight</h4>
<pre>int getHeight()</pre>
<div class="block">Returns the height of the icon in pixels.
If the actual height of the icon is unknown, -1 is returned.
<p>
This method must continue to return the icon height after the UPnP device
has been removed from the network.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The height in pixels, or -1 if unknown.</dd>
</dl>
</li>
</ul>
<a name="getSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSize</h4>
<pre>int getSize()</pre>
<div class="block">Returns the size of the icon in bytes.
This method returns the number of bytes of the icon available to read
from the <code>InputStream</code> object obtained by the
<code>getInputStream()</code> method. If the actual size can not be
determined, -1 is returned.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The icon size in bytes, or -1 if the size is unknown.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the UPnP device has been removed from
the network.</dd>
</dl>
</li>
</ul>
<a name="getDepth--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDepth</h4>
<pre>int getDepth()</pre>
<div class="block">Returns the color depth of the icon in bits.
<p>
This method must continue to return the icon depth after the UPnP device
has been removed from the network.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The color depth in bits. If the actual color depth of the icon is
unknown, -1 is returned.</dd>
</dl>
</li>
</ul>
<a name="getInputStream--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getInputStream</h4>
<pre>java.io.InputStream getInputStream()
throws java.io.IOException</pre>
<div class="block">Returns an <code>InputStream</code> object for the icon data.
The <code>InputStream</code> object provides a way for a client to read the
actual icon graphics data. The number of bytes available from this
<code>InputStream</code> object can be determined via the <code>getSize()</code>
method. The format of the data encoded can be determined by the MIME type
available via the <code>getMimeType()</code> method.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An InputStream to read the icon graphics data from.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If the <code>InputStream</code> cannot be returned.</dd>
<dd><code>java.lang.IllegalStateException</code> - if the UPnP device has been removed from
the network.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/osgi/service/upnp/UPnPIcon.html#getMimeType--"><code>getMimeType()</code></a></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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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="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><a href="../../../../org/osgi/service/upnp/UPnPException.html" title="class in org.osgi.service.upnp"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/upnp/UPnPLocalStateVariable.html" title="interface in org.osgi.service.upnp"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/upnp/UPnPIcon.html" target="_top">Frames</a></li>
<li><a href="UPnPIcon.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>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|