com.colorfulsoftware.rss

Class Image

java.lang.Object

com.colorfulsoftware.rss.Image

All Implemented Interfaces:

Serializable

public class Image
extends Object
implements Serializable

The <image> element.

From the RSS 2.0 specification...

Specifies a GIF, JPEG or PNG image that can be displayed with the channel. More info here.

<image> is an optional sub-element of <channel>, which contains three required and three optional sub-elements.

<url> is the URL of a GIF, JPEG or PNG image that represents the channel.

<title> describes the image, it's used in the ALT attribute of the HTML <img> tag when the channel is rendered in HTML.

<link> is the URL of the site, when the channel is rendered, the image is a link to the site. (Note, in practice the image <title> and <link> should have the same value as the channel's <title> and <link>.

Optional elements include <width> and <height>, numbers, indicating the width and height of the image in pixels. <description> contains text that is included in the TITLE attribute of the link formed around the image in the HTML rendering.

Maximum value for width is 144, default value is 88.

Maximum value for height is 400, default value is 31.

Author:

Bill Brown

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Description	getDescription()
Height	getHeight()
Link	getLink()
Title	getTitle()
URL	getUrl()
Width	getWidth()
int	hashCode()
String	toString() Shows the contents of the <image> element.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getUrl

public URL getUrl()

Returns:

the url element.

getTitle

public Title getTitle()

Returns:

the title element.

getLink

public Link getLink()

Returns:

the link element.

getWidth

public Width getWidth()

Returns:

the width element.

getHeight

public Height getHeight()

Returns:

the height element.

getDescription

public Description getDescription()

Returns:

the description element.

toString

public String toString()

Shows the contents of the <image> element.

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object