com.helger.photon.basic.atom

Class FeedCategory

java.lang.Object

com.helger.photon.basic.atom.AbstractFeedElement

com.helger.photon.basic.atom.FeedCategory

All Implemented Interfaces:

IFeedElement

public class FeedCategory
extends AbstractFeedElement

Constructor Summary

Constructors

Constructor and Description
FeedCategory(String sTerm)

Method Summary

Methods

Modifier and Type	Method and Description
com.helger.commons.microdom.IMicroElement	getAsElement(String sElementName) Convert this news feed element to an MicroElement with the given element name.
String	getLabel() The "label" attribute provides a human-readable label for display in end-user applications.
String	getScheme() The "scheme" attribute is an IRI that identifies a categorization scheme.
String	getTerm() The "term" attribute is a string that identifies the category to which the entry or feed belongs.
boolean	isValid() Check if this element matches the specification.
void	setLabel(String sLabel)
void	setScheme(String sScheme)
void	setTerm(String sTerm)

Methods inherited from class com.helger.photon.basic.atom.AbstractFeedElement

getLanguage, setLanguage, setLanguage

Methods inherited from class java.lang.Object

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

Constructor Detail

FeedCategory

public FeedCategory(@Nullable
            String sTerm)

Method Detail

setTerm

public void setTerm(@Nullable
           String sTerm)

getTerm

@Nullable
public String getTerm()

The "term" attribute is a string that identifies the category to which the entry or feed belongs. Category elements MUST have a "term" attribute.

Returns:

term

setScheme

public void setScheme(@Nullable
             String sScheme)

getScheme

@Nullable
public String getScheme()

The "scheme" attribute is an IRI that identifies a categorization scheme. Category elements MAY have a "scheme" attribute.

Returns:

scheme

setLabel

public void setLabel(@Nullable
            String sLabel)

getLabel

@Nullable
public String getLabel()

The "label" attribute provides a human-readable label for display in end-user applications. The content of the "label" attribute is Language-Sensitive. Entities such as "&amp;" and "&lt;" represent their corresponding characters ("&" and "<", respectively), not markup. Category elements MAY have a "label" attribute.

Returns:

type

getAsElement

public com.helger.commons.microdom.IMicroElement getAsElement(String sElementName)

Description copied from interface: IFeedElement

Convert this news feed element to an MicroElement with the given element name. In case this element is not valid according to IFeedElement.isValid() it should be safe anyway to create an element.

Parameters:

sElementName - The element name to use. May neither be null nor empty.

Returns:

The created IMicroElement and never null.

isValid

public boolean isValid()

Description copied from interface: IFeedElement

Check if this element matches the specification. This check method should only be called once the feed is assembled completely since there are interdependencies between the main feed and its entries.

Returns:

true if the element is valid, and false otherwise.