be.ceau.podcastparser.namespace.root.impl

Class Atom

java.lang.Object

be.ceau.podcastparser.namespace.root.impl.Atom

All Implemented Interfaces:

Namespace, RootNamespace

public class Atom
extends Object
implements RootNamespace, Namespace

Atom Syndication Format

Atom is an XML-based document format that describes lists of related information known as "feeds". Feeds are composed of a number of items, known as "entries", each with an extensible set of attached metadata.

See Also:

Atom specification

Method Summary

Modifier and Type	Method and Description
Set<String>	getAlternativeNames() A namespace has a single, specific, agreed upon name.
String	getName() A namespace has a single, specific, agreed upon name.
static Atom	instance()
void	parseFeed(PodcastParserContext ctx)
Item	parseItem(PodcastParserContext ctx)
void	process(PodcastParserContext ctx) Process any additional information from the XMLStreamReader, at its current position, onto the given Feed in the PodcastParserContext according to the namespace specification.
void	process(PodcastParserContext ctx, Item item) Process any additional information from the XMLStreamReader, at its current position, onto the given Item according to the namespace specification.

Methods inherited from class java.lang.Object

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

Methods inherited from interface be.ceau.podcastparser.namespace.Namespace

isMatch, mustDelegateTo

Method Detail

instance

public static Atom instance()

getName

public String getName()

Description copied from interface: Namespace

A namespace has a single, specific, agreed upon name. However, quite a few namespaces are denoted by multiple names in real world podcast XML files.

Specified by:

getName in interface Namespace

Returns:

the canonical name for this Namespace, not null identified.

See Also:

Namespace.getAlternativeNames()

getAlternativeNames

public Set<String> getAlternativeNames()

Description copied from interface: Namespace

A namespace has a single, specific, agreed upon name. However, quite a few namespaces are denoted by multiple names in real world podcast XML files.

Specified by:

getAlternativeNames in interface Namespace

Returns:

a Set of names by which this Namespace is also identified, may be empty, never null

See Also:

Namespace.getName()

parseFeed

public void parseFeed(PodcastParserContext ctx)
               throws XMLStreamException

Specified by:

parseFeed in interface RootNamespace

Throws:

XMLStreamException

parseItem

public Item parseItem(PodcastParserContext ctx)
               throws XMLStreamException

Specified by:

parseItem in interface RootNamespace

Throws:

XMLStreamException

process

public void process(PodcastParserContext ctx)
             throws XMLStreamException

Description copied from interface: Namespace

Process any additional information from the XMLStreamReader, at its current position, onto the given Feed in the PodcastParserContext according to the namespace specification.

Specified by:

process in interface Namespace

Parameters:

ctx - PodcastParserContext instance in the process of being built

Throws:

XMLStreamException - if any

process

public void process(PodcastParserContext ctx,
                    Item item)
             throws XMLStreamException

Description copied from interface: Namespace

Process any additional information from the XMLStreamReader, at its current position, onto the given Item according to the namespace specification.

Specified by:

process in interface Namespace

Parameters:

ctx - PodcastParserContext instance in the process of being built

item - Item instance in the process of being built

Throws:

XMLStreamException - if any