Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright (c) OSGi Alliance (2002, 2013). All Rights Reserved.
   *
   * Licensed under the Apache License, Version 2.0 (the "License");
   * you may not use this file except in compliance with the License.
   * You may obtain a copy of the License at
   *
   *      http://www.apache.org/licenses/LICENSE-2.0
   *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 
 package org.osgi.service.upnp;
 
A UPnP icon representation. Each UPnP device can contain zero or more icons.

Author(s):
$Id: dd5af435f008f150485b5449f89e1fbf70e4bda7 $
 
 public interface UPnPIcon {
Returns the MIME type of the icon. This method returns the format in which the icon graphics, read from the InputStream object obtained by the getInputStream() method, is encoded.

The format of the returned string is in accordance to RFC2046. A list of valid MIME types is maintained by the IANA.

Typical values returned include: "image/jpeg" or "image/gif"

This method must continue to return the icon MIME type after the UPnP device has been removed from the network.

Returns:
The MIME type of the encoded icon.
 
Returns the width of the icon in pixels. If the actual width of the icon is unknown, -1 is returned.

This method must continue to return the icon width after the UPnP device has been removed from the network.

Returns:
The width in pixels, or -1 if unknown.
 
 	int getWidth();

Returns the height of the icon in pixels. If the actual height of the icon is unknown, -1 is returned.

This method must continue to return the icon height after the UPnP device has been removed from the network.

Returns:
The height in pixels, or -1 if unknown.
 
 	int getHeight();

Returns the size of the icon in bytes. This method returns the number of bytes of the icon available to read from the InputStream object obtained by the getInputStream() method. If the actual size can not be determined, -1 is returned.

Returns:
The icon size in bytes, or -1 if the size is unknown.
Throws:
java.lang.IllegalStateException if the UPnP device has been removed from the network.
 
 	int getSize();

Returns the color depth of the icon in bits.

This method must continue to return the icon depth after the UPnP device has been removed from the network.

Returns:
The color depth in bits. If the actual color depth of the icon is unknown, -1 is returned.
	int getDepth();

Returns an InputStream object for the icon data. The InputStream object provides a way for a client to read the actual icon graphics data. The number of bytes available from this InputStream object can be determined via the getSize() method. The format of the data encoded can be determined by the MIME type available via the getMimeType() method.

Returns:
An InputStream to read the icon graphics data from.
Throws:
java.io.IOException If the InputStream cannot be returned.
java.lang.IllegalStateException if the UPnP device has been removed from the network.
See also:
getMimeType()
New to GrepCode? Check out our FAQ X