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* }

• Overview > juneau-dto > Atom
• package-summary.html

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Feed	authors(Person... authors) Sets the list of authors for this object.
Feed	base(Object base) Sets the URI base of this object.
Feed	categories(Category... categories) Sets the list of categories of this object.
Feed	contributors(Person... contributors) Sets the list of contributors of this object.
Feed	entries(Entry... entries) Sets the entries in the feed.
Feed	generator(Generator generator) Sets the generator information on this feed.
Entry[]	getEntries() Returns the entries in the feed.
Generator	getGenerator() Returns generator information on this feed.
Icon	getIcon() Returns the feed icon.
Logo	getLogo() Returns the feed logo.
Text	getSubTitle() Returns the feed subtitle.
Feed	icon(Icon icon) Sets the feed icon.
Feed	id(Id id) Sets the ID of this object.
Feed	lang(String lang) Sets the language of this object.
Feed	links(Link... links) Sets the list of links of this object.
Feed	logo(Logo logo) Sets the feed logo.
Feed	rights(String rights) Sets the rights statement of this object.
Feed	rights(Text rights) Sets the rights statement of this object.
Feed	subtitle(String subtitle) Sets the feed subtitle.
Feed	subtitle(Text subtitle) Sets the feed subtitle.
Feed	title(String title) Sets the title of this object.
Feed	title(Text title) Sets the title of this object.
Feed	updated(Calendar updated) Sets the update timestamp of this object.
Feed	updated(String updated) Sets the update timestamp of this object.

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

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

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 Detail

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 Detail

getGenerator

public Generator getGenerator()

Returns generator information on this feed.

Returns:

The generator information on this feed.

generator

@Beanp(value="generator")
public Feed generator(Generator generator)

Sets the generator information on this feed.

Parameters:

generator - The generator information on this feed.

Returns:

This object (for method chaining).

getIcon

public Icon getIcon()

Returns the feed icon.

Returns:

The feed icon.

icon

@Beanp(value="icon")
public Feed icon(Icon icon)

Sets the feed icon.

Parameters:

icon - The feed icon.

Returns:

This object (for method chaining).

getLogo

public Logo getLogo()

Returns the feed logo.

Returns:

The feed logo.

logo

@Beanp(value="logo")
public Feed logo(Logo logo)

Sets the feed logo.

Parameters:

logo - The feed logo.

Returns:

This object (for method chaining).

getSubTitle

@Beanp(value="subtitle")
public Text getSubTitle()

Returns the feed subtitle.

Returns:

The feed subtitle.

subtitle

@Beanp(value="subtitle")
public Feed subtitle(Text subtitle)

Sets the feed subtitle.

Parameters:

subtitle - The feed subtitle.

Returns:

This object (for method chaining).

subtitle

public Feed subtitle(String subtitle)

Sets the feed subtitle.

Parameters:

subtitle - The feed subtitle.

Returns:

This object (for method chaining).

getEntries

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

Returns the entries in the feed.

Returns:

The entries in the feed.

entries

@Beanp(value="entries")
public Feed entries(Entry... entries)

Sets the entries in the feed.

Parameters:

entries - The entries in the feed.

Returns:

This object (for method chaining).

authors

public Feed authors(Person... authors)

Description copied from class: CommonEntry

Sets the list of authors for this object.

Overrides:

authors in class CommonEntry

Parameters:

authors - The list of authors for this object.

Returns:

This object (for method chaining).

categories

public Feed categories(Category... categories)

Description copied from class: CommonEntry

Sets the list of categories of this object.

Overrides:

categories in class CommonEntry

Parameters:

categories - The list of categories of this object.

Returns:

This object (for method chaining).

contributors

public Feed contributors(Person... contributors)

Description copied from class: CommonEntry

Sets the list of contributors of this object.

Overrides:

contributors in class CommonEntry

Parameters:

contributors - The list of contributors of this object.

Returns:

This object (for method chaining).

id

public Feed id(Id id)

Description copied from class: CommonEntry

Sets the ID of this object.

Overrides:

id in class CommonEntry

Parameters:

id - The ID of this object.

Returns:

This object (for method chaining).

links

public Feed links(Link... links)

Description copied from class: CommonEntry

Sets the list of links of this object.

Overrides:

links in class CommonEntry

Parameters:

links - The list of links of this object.

Returns:

This object (for method chaining).

rights

public Feed rights(Text rights)

Description copied from class: CommonEntry

Sets the rights statement of this object.

Overrides:

rights in class CommonEntry

Parameters:

rights - The rights statement of this object.

Returns:

This object (for method chaining).

rights

public Feed rights(String rights)

Description copied from class: CommonEntry

Sets the rights statement of this object.

Overrides:

rights in class CommonEntry

Parameters:

rights - The rights statement of this object.

Returns:

This object (for method chaining).

title

public Feed title(Text title)

Description copied from class: CommonEntry

Sets the title of this object.

Overrides:

title in class CommonEntry

Parameters:

title - The title of this object.

Returns:

This object (for method chaining).

title

public Feed title(String title)

Description copied from class: CommonEntry

Sets the title of this object.

Overrides:

title in class CommonEntry

Parameters:

title - The title of this object.

Returns:

This object (for method chaining).

updated

public Feed updated(Calendar updated)

Description copied from class: CommonEntry

Sets the update timestamp of this object.

Overrides:

updated in class CommonEntry

Parameters:

updated - The update timestamp of this object.

Returns:

This object (for method chaining).

updated

public Feed updated(String updated)

Description copied from class: CommonEntry

Sets the update timestamp of this object.

Overrides:

updated in class CommonEntry

Parameters:

updated - The update timestamp of this object in ISO8601 format.

Returns:

This object (for method chaining).

base

public Feed base(Object base)

Description copied from class: Common

Sets the URI base of this object.

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

URIs defined by UriResolver can be used for values.

Overrides:

base in class Common

Parameters:

base - The URI base of this object.

Returns:

This object (for method chaining).

lang

public Feed lang(String lang)

Description copied from class: Common

Sets the language of this object.

Overrides:

lang in class Common

Parameters:

lang - The language of this object.

Returns:

This object (for method chaining).