com.helger.photon.basic.atom

Class FeedLink

java.lang.Object

com.helger.photon.basic.atom.AbstractFeedElement

com.helger.photon.basic.atom.FeedLink

All Implemented Interfaces:

IFeedElement

public class FeedLink
extends AbstractFeedElement

Represents a link in the ATOM feed

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static String	REL_ALTERNATE
static String	REL_SELF

Constructor Summary

Constructors

Constructor and Description
FeedLink(com.helger.commons.url.ISimpleURL aHref)
FeedLink(com.helger.commons.url.ISimpleURL aHref, String sRel)
FeedLink(String sHref)
FeedLink(String sHref, String sRel)

Method Summary

Modifier and Type	Method and Description
com.helger.xml.microdom.IMicroElement	getAsElement(String sElementName) Convert this news feed element to an MicroElement with the given element name.
String	getHref() The "href" attribute contains the link's IRI. atom:link elements MUST have an href attribute, whose value MUST be a IRI reference [RFC3987].
Locale	getHrefLang() The "hreflang" attribute's content describes the language of the resource pointed to by the href attribute.
int	getLength() The "length" attribute indicates an advisory length of the linked content in octets; it is a hint about the content length of the representation returned when the IRI in the href attribute is mapped to a URI and dereferenced.
String	getRel() atom:link elements MAY have a "rel" attribute that indicates the link relation type.
String	getTitle() The "title" attribute conveys human-readable information about the link.
String	getType() On the link element, the "type" attribute's value is an advisory media type: it is a hint about the type of the representation that is expected to be returned when the value of the href attribute is dereferenced.
boolean	isValid() Check if this element matches the specification.
void	setHref(String sHref)
void	setHrefLang(Locale aContentLocale)
void	setLength(int nLength)
void	setRel(String sRel)
void	setTitle(String sTitle)
void	setType(String sType)

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

Field Detail

REL_SELF

public static final String REL_SELF

See Also:

Constant Field Values

REL_ALTERNATE

public static final String REL_ALTERNATE

See Also:

Constant Field Values

Constructor Detail

FeedLink

public FeedLink(@Nonnull
                com.helger.commons.url.ISimpleURL aHref)

FeedLink

public FeedLink(@Nonnull
                com.helger.commons.url.ISimpleURL aHref,
                @Nullable
                String sRel)

FeedLink

public FeedLink(@Nullable
                String sHref)

FeedLink

public FeedLink(@Nullable
                String sHref,
                @Nullable
                String sRel)

Method Detail

setHref

public void setHref(@Nullable
                    String sHref)

getHref

@Nullable
public String getHref()

The "href" attribute contains the link's IRI. atom:link elements MUST have an href attribute, whose value MUST be a IRI reference [RFC3987].

Returns:

href

setRel

public void setRel(@Nullable
                   String sRel)

getRel

@Nullable
public String getRel()

atom:link elements MAY have a "rel" attribute that indicates the link relation type. If the "rel" attribute is not present, the link element MUST be interpreted as if the link relation type is "alternate".

The value of "rel" MUST be a string that is non-empty and matches either the "isegment-nz-nc" or the "IRI" production in [RFC3987]. Note that use of a relative reference other than a simple name is not allowed. If a name is given, implementations MUST consider the link relation type equivalent to the same name registered within the IANA Registry of Link Relations (Section 7), and thus to the IRI that would be obtained by appending the value of the rel attribute to the string "http://www.iana.org/assignments/relation/". The value of "rel" describes the meaning of the link, but does not impose any behavioral requirements on Atom Processors.

This document defines five initial values for the Registry of Link Relations:

1. The value "alternate" signifies that the IRI in the value of the href attribute identifies an alternate version of the resource described by the containing element.
2. The value "related" signifies that the IRI in the value of the href attribute identifies a resource related to the resource described by the containing element. For example, the feed for a site that discusses the performance of the search engine at "http://search.example.com" might contain, as a child of atom:feed:

    <link rel="related" href="http://search.example.com/"/>
    

   An identical link might appear as a child of any atom:entry whose content contains a discussion of that same search engine.
3. The value "self" signifies that the IRI in the value of the href attribute identifies a resource equivalent to the containing element.
4. The value "enclosure" signifies that the IRI in the value of the href attribute identifies a related resource that is potentially large in size and might require special handling. For atom:link elements with rel="enclosure", the length attribute SHOULD be provided.
5. The value "via" signifies that the IRI in the value of the href attribute identifies a resource that is the source of the information provided in the containing element.

Returns:

rel

setType

public void setType(@Nullable
                    String sType)

getType

@Nullable
public String getType()

On the link element, the "type" attribute's value is an advisory media type: it is a hint about the type of the representation that is expected to be returned when the value of the href attribute is dereferenced. Note that the type attribute does not override the actual media type returned with the representation. Link elements MAY have a type attribute, whose value MUST conform to the syntax of a MIME media type [MIMEREG].

Returns:

type

setHrefLang

public void setHrefLang(@Nullable
                        Locale aContentLocale)

getHrefLang

@Nullable
public Locale getHrefLang()

The "hreflang" attribute's content describes the language of the resource pointed to by the href attribute. When used together with the rel="alternate", it implies a translated version of the entry. Link elements MAY have an hreflang attribute, whose value MUST be a language tag [RFC3066].

Returns:

href language

setTitle

public void setTitle(@Nullable
                     String sTitle)

getTitle

@Nullable
public String getTitle()

The "title" attribute conveys human-readable information about the link. The content of the "title" attribute is Language-Sensitive. Entities such as "&amp;" and "&lt;" represent their corresponding characters ("&" and "<", respectively), not markup. Link elements MAY have a title attribute.

Returns:

title

setLength

public void setLength(int nLength)

getLength

public int getLength()

The "length" attribute indicates an advisory length of the linked content in octets; it is a hint about the content length of the representation returned when the IRI in the href attribute is mapped to a URI and dereferenced. Note that the length attribute does not override the actual content length of the representation as reported by the underlying protocol. Link elements MAY have a length attribute.

Returns:

length

getAsElement

@Nonnull
public com.helger.xml.microdom.IMicroElement getAsElement(@Nonnull
                                                                    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.