christophedelory.rss
Class Source

java.lang.Object
  christophedelory.rss.Source

public class Source
extends Object

The RSS channel that the item came from. The purpose of this element is to propagate credit for links, to publicize the sources of news items. It can be used in the Post command of an aggregator. It should be generated automatically when forwarding an item from an aggregator to a weblog authoring tool.

Version:

$Revision: 92 $

Author:

Christophe Delory

Constructor Summary

Source()

Method Summary

String	getChannelName() Returns the name of the RSS channel that the item came from, derived from its title.
URI	getURL() Returns a link to the XMLization of the source.
String	getURLString() Returns a link to the XMLization of the source.
void	setChannelName(String channelName) Initializes the name of the RSS channel that the item came from, derived from its title.
void	setURL(URI url) Initializes a link to the XMLization of the source.
void	setURLString(String url) Initializes a link to the XMLization of the source.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Source

public Source()

Method Detail

setChannelName

public void setChannelName(String channelName)

Initializes the name of the RSS channel that the item came from, derived from its title.

Parameters:

channelName - the channel's name. Shall not be null.

Throws:

NullPointerException - if channelName is null.

See Also:

getChannelName()

getChannelName

public String getChannelName()

Returns the name of the RSS channel that the item came from, derived from its title. Example: "Tomalak's Realm". No default value.

Returns:

the channel's name. May be null if not yet initialized.

See Also:

setChannelName(java.lang.String)

setURLString

public void setURLString(String url)
                  throws URISyntaxException

Initializes a link to the XMLization of the source.

Parameters:

url - an URL as a string. Shall not be null.

Throws:

NullPointerException - if url is null.

URISyntaxException - if the given string violates RFC 2396, as augmented by the URI deviations.

See Also:

getURLString(), setURL(java.net.URI)

getURLString

public String getURLString()

Returns a link to the XMLization of the source.

Returns:

an URL as a string. Shall not be null.

Throws:

NullPointerException - if no URL has been defined in this source element.

See Also:

setURLString(java.lang.String), getURL()

setURL

public void setURL(URI url)

Initializes a link to the XMLization of the source.

Parameters:

url - an URL. Shall not be null.

Throws:

NullPointerException - if url is null.

See Also:

getURL(), setURLString(java.lang.String)

getURL

public URI getURL()

Returns a link to the XMLization of the source. Example: "http://www.tomalak.org/links2.xml". No default value.

Returns:

an URL. May be null if not yet initialized.

See Also:

setURL(java.net.URI), getURLString()