Package org.apache.juneau.dto.atom

Class Feed

java.lang.Object

org.apache.juneau.dto.atom.Common

org.apache.juneau.dto.atom.CommonEntry

org.apache.juneau.dto.atom.Feed

@Bean(typeName="feed")
public class Feed
extends CommonEntry

Top-level ATOM feed object.

Represents an atomFeed construct in the RFC4287 specification.

Schema

atomFeed = element atom:feed { atomCommonAttributes, (atomAuthor* & atomCategory* & atomContributor* & atomGenerator? & atomIcon? & atomId & atomLink* & atomLogo? & atomRights? & atomSubtitle? & atomTitle & atomUpdated & extensionElement*), atomEntry* }

See Also:

• Overview > juneau-dto > Atom

Constructor Summary

Constructors

Constructor	Description
Feed()	Bean constructor.
Feed(String id, String title, String updated)	Normal constructor.
Feed(Id id, Text title, Calendar updated)	Normal constructor.

Method Summary

Modifier and Type	Method	Description
Entry[]	getEntries()	Bean property getter: entries.
Generator	getGenerator()	Bean property getter: generator.
Icon	getIcon()	Bean property getter: icon.
Logo	getLogo()	Bean property getter: logo.
Text	getSubtitle()	Bean property getter: subtitle.
Feed	setAuthors(Person... value)	Bean property setter: authors.
Feed	setBase(Object value)	Bean property setter: term.
Feed	setCategories(Category... value)	Bean property setter: categories.
Feed	setContributors(Person... value)	Bean property setter: contributors.
Feed	setEntries(Entry... value)	Bean property setter: entries.
Feed	setGenerator(Generator value)	Bean property setter: generator.
Feed	setIcon(Icon value)	Bean property setter: icon.
Feed	setId(String value)	Bean property fluent setter: id.
Feed	setId(Id value)	Bean property setter: id.
Feed	setLang(String value)	Bean property setter: lang.
Feed	setLinks(Link... value)	Bean property setter: links.
Feed	setLogo(Logo value)	Bean property setter: logo.
Feed	setRights(String value)	Bean property fluent setter: rights.
Feed	setRights(Text value)	Bean property setter: rights.
Feed	setSubtitle(String value)	Bean property fluent setter: subtitle.
Feed	setSubtitle(Text value)	Bean property setter: subtitle.
Feed	setTitle(String value)	Bean property fluent setter: title.
Feed	setTitle(Text value)	Bean property setter: title.
Feed	setUpdated(String value)	Bean property fluent setter: updated.
Feed	setUpdated(Calendar value)	Bean property setter: updated.

Methods inherited from class org.apache.juneau.dto.atom.CommonEntry

getAuthors, getCategories, getContributors, getId, getLinks, getRights, getTitle, getUpdated

Methods inherited from class org.apache.juneau.dto.atom.Common

getBase, getLang, toString

Methods inherited from class java.lang.Object

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

Constructor Details

Feed

public Feed(Id id,
 Text title,
 Calendar updated)

Normal constructor.

Parameters:

id - The feed identifier.

title - The feed title.

updated - The feed updated timestamp.

Feed

public Feed(String id,
 String title,
 String updated)

Normal constructor.

Parameters:

id - The feed identifier.

title - The feed title.

updated - The feed updated timestamp.

Feed

public Feed()

Bean constructor.

Method Details

getGenerator

public Generator getGenerator()

Bean property getter: generator.

The generator information on this feed.

Returns:

The property value, or null if it is not set.

setGenerator

public Feed setGenerator(Generator value)

Bean property setter: generator.

The generator information on this feed.

Parameters:

value - The new value for this property.
Can be null to unset the property.

Returns:

This object

getIcon

public Icon getIcon()

Bean property getter: icon.

The feed icon.

Returns:

The property value, or null if it is not set.

setIcon

public Feed setIcon(Icon value)

Bean property setter: icon.

The feed icon.

Parameters:

value - The new value for this property.
Can be null to unset the property.

Returns:

This object

getLogo

public Logo getLogo()

Bean property getter: logo.

The feed logo.

Returns:

The property value, or null if it is not set.

setLogo

public Feed setLogo(Logo value)

Bean property setter: logo.

The feed logo.

Parameters:

value - The new value for this property.
Can be null to unset the property.

Returns:

This object

getSubtitle

public Text getSubtitle()

Bean property getter: subtitle.

The feed subtitle.

Returns:

The property value, or null if it is not set.

setSubtitle

public Feed setSubtitle(Text value)

Bean property setter: subtitle.

The feed subtitle.

Parameters:

value - The new value for this property.
Can be null to unset the property.

Returns:

This object

setSubtitle

public Feed setSubtitle(String value)

Bean property fluent setter: subtitle.

The feed subtitle.

Parameters:

value - The new value for this property.
Can be null to unset the property.

Returns:

This object.

getEntries

@Xml(format=COLLAPSED)
public Entry[] getEntries()

Bean property getter: entries.

The entries in the feed.

Returns:

The property value, or null if it is not set.

setEntries

public Feed setEntries(Entry... value)

Bean property setter: entries.

The entries in the feed.

Parameters:

value - The new value for this property.
Can be null to unset the property.

Returns:

This object

setBase

public Feed setBase(Object value)

Description copied from class: Common

Bean property setter: term.

The URI base of this object.

The value can be of any of the following types: URI, URL, String. Strings must be valid URIs.

Overrides:

setBase in class CommonEntry

Parameters:

value - The new value for this property.
Can be null to unset the property.

Returns:

This object

setLang

public Feed setLang(String value)

Description copied from class: Common

Bean property setter: lang.

The language of this object.

Overrides:

setLang in class CommonEntry

Parameters:

value - The new value for this property.
Can be null to unset the property.

Returns:

This object

setAuthors

public Feed setAuthors(Person... value)

Description copied from class: CommonEntry

Bean property setter: authors.

The list of authors for this object.

Overrides:

setAuthors in class CommonEntry

Parameters:

value - The new value for this property.
Can be null to unset the property.

Returns:

This object

setCategories

public Feed setCategories(Category... value)

Description copied from class: CommonEntry

Bean property setter: categories.

The list of categories of this object.

Overrides:

setCategories in class CommonEntry

Parameters:

value - The new value for this property.
Can be null to unset the property.

Returns:

This object

setContributors

public Feed setContributors(Person... value)

Description copied from class: CommonEntry

Bean property setter: contributors.

The list of contributors of this object.

Overrides:

setContributors in class CommonEntry

Parameters:

value - The new value for this property.
Can be null to unset the property.

Returns:

This object

setId

public Feed setId(String value)

Description copied from class: CommonEntry

Bean property fluent setter: id.

The ID of this object.

Overrides:

setId in class CommonEntry

Parameters:

value - The new value for this property.
Can be null to unset the property.

Returns:

This object.

setId

public Feed setId(Id value)

Description copied from class: CommonEntry

Bean property setter: id.

The ID of this object.

Overrides:

setId in class CommonEntry

Parameters:

value - The new value for this property.
Can be null to unset the property.

Returns:

This object

setLinks

public Feed setLinks(Link... value)

Description copied from class: CommonEntry

Bean property setter: links.

The list of links of this object.

Overrides:

setLinks in class CommonEntry

Parameters:

value - The new value for this property.
Can be null to unset the property.

Returns:

This object

setRights

public Feed setRights(String value)

Description copied from class: CommonEntry

Bean property fluent setter: rights.

The rights statement of this object.

Overrides:

setRights in class CommonEntry

Parameters:

value - The new value for this property.
Can be null to unset the property.

Returns:

This object.

setRights

public Feed setRights(Text value)

Description copied from class: CommonEntry

Bean property setter: rights.

The rights statement of this object.

Overrides:

setRights in class CommonEntry

Parameters:

value - The new value for this property.
Can be null to unset the property.

Returns:

This object

setTitle

public Feed setTitle(String value)

Description copied from class: CommonEntry

Bean property fluent setter: title.

The title of this object.

Overrides:

setTitle in class CommonEntry

Parameters:

value - The new value for this property.
Can be null to unset the property.

Returns:

This object.

setTitle

public Feed setTitle(Text value)

Description copied from class: CommonEntry

Bean property setter: title.

The title of this object.

Overrides:

setTitle in class CommonEntry

Parameters:

value - The new value for this property.
Can be null to unset the property.

Returns:

This object

setUpdated

public Feed setUpdated(String value)

Description copied from class: CommonEntry

Bean property fluent setter: updated.

The update timestamp of this object.

Overrides:

setUpdated in class CommonEntry

Parameters:

value - The new value for this property.
Can be null to unset the property.

Returns:

This object.

setUpdated

public Feed setUpdated(Calendar value)

Description copied from class: CommonEntry

Bean property setter: updated.

The update timestamp of this object.

Overrides:

setUpdated in class CommonEntry

Parameters:

value - The new value for this property.
Can be null to unset the property.

Returns:

This object