Package org.apache.juneau.bean.atom

Class AtomBuilder

java.lang.Object

org.apache.juneau.bean.atom.AtomBuilder

public class AtomBuilder
extends Object

Various useful static methods for creating ATOM elements.

Typically, you'll want to do a static import on this class and then call the methods like so...

import static org.apache.juneau.bean.atom.AtomBuilder.*; Feed feed = feed("tag:juneau.sample.com,2013:1", "Juneau ATOM specification", "2013-05-08T12:29:29Z") .setSubtitle(text("html") .setText("A <em>lot</em> of effort went into making this effortless")) .setLinks( link("alternate", "text/html", "http://www.sample.com/") .setHreflang("en"), link("self", "application/atom+xml", "http://www.sample.com/feed.atom") );

See Also:

• juneau-bean-atom

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AtomBuilder()	Constructor.

Method Summary

Modifier and Type	Method	Description
static final Category	category(String term)	Creates a Category element with the specified Category.setTerm(String) attribute.
static final Content	content()	Creates a Content element with the specified Content.setType(String) attribute.
static final Content	content(String type)	Creates a Content element.
static final Entry	entry(String id, String title, String updated)	Creates an Entry element with the specified CommonEntry.setId(Id), CommonEntry.setTitle(Text), and CommonEntry.setUpdated(Calendar) attributes.
static final Entry	entry(Id id, Text title, Calendar updated)	Creates an Entry element with the specified CommonEntry.setId(Id), CommonEntry.setTitle(Text), and CommonEntry.setUpdated(Calendar) attributes.
static final Feed	feed(String id, String title, String updated)	Creates a Feed element with the specified CommonEntry.setId(Id), CommonEntry.setTitle(Text), and CommonEntry.setUpdated(Calendar) attributes.
static final Feed	feed(Id id, Text title, Calendar updated)	Creates a Feed element with the specified CommonEntry.setId(Id), CommonEntry.setTitle(Text), and CommonEntry.setUpdated(Calendar) attributes.
static final Generator	generator(String text)	Creates a Generator element with the specified Generator.setText(String) child node.
static final Icon	icon(Object uri)	Creates an Icon element with the specified Icon.setUri(Object) attribute.
static final Id	id(String text)	Creates an Id element with the specified Id.setText(String) child node.
static final Link	link(String rel, String type, String href)	Creates a Link element with the specified Link.setRel(String), Link.setType(String), and Link.setHref(String) attributes.
static final Logo	logo(Object uri)	Creates a Logo element with the specified Logo.setUri(Object) attribute.
static final Person	person(String name)	Creates a Person element with the specified Person.setName(String) attribute.
static final Source	source()	Creates a Source element.
static final Text	text()	Creates a Text element.
static final Text	text(String type)	Creates a Text element with the specified Text.setType(String) attribute.

Methods inherited from class java.lang.Object

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

Constructor Details

AtomBuilder

protected AtomBuilder()

Constructor.

Method Details

category

public static final Category category(String term)

Creates a Category element with the specified Category.setTerm(String) attribute.

Parameters:

term - The Category.setTerm(String) attribute. Can be null to leave the property unset.

Returns:

The new element.

content

public static final Content content()

Creates a Content element with the specified Content.setType(String) attribute.

Returns:

The new element.

content

public static final Content content(String type)

Creates a Content element.

Parameters:

type - The Content.setType(String) attribute. Can be null to leave the property unset.

Returns:

The new element.

entry

public static final Entry entry(Id id,
 Text title,
 Calendar updated)

Creates an Entry element with the specified CommonEntry.setId(Id), CommonEntry.setTitle(Text), and CommonEntry.setUpdated(Calendar) attributes.

Parameters:

id - The CommonEntry.setId(Id) attribute. Can be null to leave the property unset.

title - The CommonEntry.setTitle(Text) attribute. Can be null to leave the property unset.

updated - The CommonEntry.setUpdated(Calendar) attribute. Can be null to leave the property unset.

Returns:

The new element.

entry

public static final Entry entry(String id,
 String title,
 String updated)

Creates an Entry element with the specified CommonEntry.setId(Id), CommonEntry.setTitle(Text), and CommonEntry.setUpdated(Calendar) attributes.

Parameters:

id - The CommonEntry.setId(Id) attribute. Can be null, in which case the property is set to an Id with no text (not left unset).

title - The CommonEntry.setTitle(Text) attribute. Can be null, in which case the property is set to a Text with no text (not left unset).

updated - The CommonEntry.setUpdated(Calendar) attribute. Can be null or blank to leave the property unset.

Returns:

The new element.

feed

public static final Feed feed(Id id,
 Text title,
 Calendar updated)

Creates a Feed element with the specified CommonEntry.setId(Id), CommonEntry.setTitle(Text), and CommonEntry.setUpdated(Calendar) attributes.

Parameters:

id - The CommonEntry.setId(Id) attribute. Can be null to leave the property unset.

title - The CommonEntry.setTitle(Text) attribute. Can be null to leave the property unset.

updated - The CommonEntry.setUpdated(Calendar) attribute. Can be null to leave the property unset.

Returns:

The new element.

feed

public static final Feed feed(String id,
 String title,
 String updated)

Creates a Feed element with the specified CommonEntry.setId(Id), CommonEntry.setTitle(Text), and CommonEntry.setUpdated(Calendar) attributes.

Parameters:

id - The CommonEntry.setId(Id) attribute. Can be null, in which case the property is set to an Id with no text (not left unset).

title - The CommonEntry.setTitle(Text) attribute. Can be null, in which case the property is set to a Text with no text (not left unset).

updated - The CommonEntry.setUpdated(Calendar) attribute. Can be null or blank to leave the property unset.

Returns:

The new element.

generator

public static final Generator generator(String text)

Creates a Generator element with the specified Generator.setText(String) child node.

Parameters:

text - The Generator.setText(String) child node. Can be null to leave the property unset.

Returns:

The new element.

icon

public static final Icon icon(Object uri)

Creates an Icon element with the specified Icon.setUri(Object) attribute.

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.

Parameters:

uri - The Icon.setUri(Object) attribute. Can be null to leave the property unset.

Returns:

The new element.

id

public static final Id id(String text)

Creates an Id element with the specified Id.setText(String) child node.

Parameters:

text - The Id.setText(String) child node. Can be null to leave the property unset.

Returns:

The new element.

link

public static final Link link(String rel,
 String type,
 String href)

Creates a Link element with the specified Link.setRel(String), Link.setType(String), and Link.setHref(String) attributes.

Parameters:

rel - The Link.setRel(String) attribute. Can be null to leave the property unset.

type - The Link.setType(String) attribute. Can be null to leave the property unset.

href - The Link.setHref(String) attribute. Can be null to leave the property unset.

Returns:

The new element.

logo

public static final Logo logo(Object uri)

Creates a Logo element with the specified Logo.setUri(Object) attribute.

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.

Parameters:

uri - The Logo.setUri(Object) attribute. Can be null to leave the property unset.

Returns:

The new element.

person

public static final Person person(String name)

Creates a Person element with the specified Person.setName(String) attribute.

Parameters:

name - The Person.setName(String) attribute. Can be null to leave the property unset.

Returns:

The new element.

source

public static final Source source()

Creates a Source element.

Returns:

The new element.

text

public static final Text text()

Creates a Text element.

Returns:

The new element.

text

public static final Text text(String type)

Creates a Text element with the specified Text.setType(String) attribute.

Parameters:

type - The Text.setType(String) attribute. Can be null to leave the property unset.

Returns:

The new element.