io.micronaut.rss.jsonfeed

Class JsonFeed

java.lang.Object

io.micronaut.rss.jsonfeed.JsonFeed

@Introspected
public class JsonFeed
extends java.lang.Object

A JSON Feed is a list that may change over time, and the individual items in the list may change..

Since:

2.2.0

Author:

Sergio del Amo, mark1626

See Also:

JSON Feed 1.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsonFeed.Builder JSON Feed Builder.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_AUTHOR
static java.lang.String	KEY_AUTHORS
static java.lang.String	KEY_DESCRIPTION
static java.lang.String	KEY_EXPIRED
static java.lang.String	KEY_FAVICON
static java.lang.String	KEY_FEED_URL
static java.lang.String	KEY_HOME_PAGE_URL
static java.lang.String	KEY_HUBS
static java.lang.String	KEY_ICON
static java.lang.String	KEY_ITEMS
static java.lang.String	KEY_LANGUAGE
static java.lang.String	KEY_NEXT_URL
static java.lang.String	KEY_TITLE
static java.lang.String	KEY_USER_COMMENT
static java.lang.String	KEY_VERSION
static java.lang.String	VERSION_JSON_FEED_1
static java.lang.String	VERSION_JSON_FEED_1_1

Constructor Summary

Constructors

Constructor and Description
JsonFeed()

Method Summary

Modifier and Type	Method and Description
void	addAuthor(JsonFeedAuthor author)
void	addHub(JsonHub hub)
void	addItem(JsonFeedItem item)
static JsonFeed.Builder	builder()
static JsonFeed.Builder	builder(java.lang.String title, java.util.List<JsonFeedItem> items) Creates builder with required fields.
static JsonFeed.Builder	builder(java.lang.String version, java.lang.String title, java.util.List<JsonFeedItem> items)
java.util.List<JsonFeedAuthor>	getAuthors() Specifies one or more feed authors.
java.lang.String	getDescription() Detail on what the feed is about.
java.lang.Boolean	getExpired() Says whether or not the feed is finished — that is, whether or not it will ever update again.
java.lang.String	getFavicon() The URL of an image for the feed suitable to be used in a source list.
java.lang.String	getFeedUrl() The URL of the feed, and serves as the unique identifier for the feed.
java.lang.String	getHomePageUrl() The URL of the resource that the feed describes.
java.util.List<JsonHub>	getHubs() Describes endpoints that can be used to subscribe to real-time notifications from the publisher of this feed.
java.lang.String	getIcon() The URL of an image for the feed suitable to be used in a timeline, much the way an avatar might be used.
java.util.List<JsonFeedItem>	getItems() The items in the field.
java.lang.String	getLanguage() The primary language for the feed in the format specified in RFC 5646.
java.lang.String	getNextURL() The URL of a feed that provides the next n items, where n is determined by the publisher.
java.lang.String	getTitle() The name of the feed, which will often correspond to the name of the website.
java.lang.String	getUserComment() Description of the purpose of the feed.
java.lang.String	getVersion() Returns the URL of the version of the format the feed uses.
void	setAuthors(java.util.List<JsonFeedAuthor> authors) Specifies one or more feed authors.
void	setDescription(java.lang.String description) Detail on what the feed is about.
void	setExpired(java.lang.Boolean expired) Says whether or not the feed is finished — that is, whether or not it will ever update again.
void	setFavicon(java.lang.String favicon) The URL of an image for the feed suitable to be used in a source list.
void	setFeedUrl(java.lang.String feedUrl) The URL of the feed, and serves as the unique identifier for the feed.
void	setHomePageUrl(java.lang.String homePageUrl) The URL of the resource that the feed describes.
void	setHubs(java.util.List<JsonHub> hubs) Describes endpoints that can be used to subscribe to real-time notifications from the publisher of this feed.
void	setIcon(java.lang.String icon) The URL of an image for the feed suitable to be used in a timeline, much the way an avatar might be used.
void	setItems(java.util.List<JsonFeedItem> items) The items in the field.
void	setLanguage(java.lang.String language) The primary language for the feed in the format specified in RFC 5646.
void	setNextURL(java.lang.String nextURL) The URL of a feed that provides the next n items, where n is determined by the publisher.
void	setTitle(java.lang.String title) The name of the feed, which will often correspond to the name of the website.
void	setUserComment(java.lang.String userComment) Description of the purpose of the feed.
void	setVersion(java.lang.String version) URL of the version of the format the feed uses.
java.util.Map<java.lang.String,java.lang.Object>	toMap()

Methods inherited from class java.lang.Object

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

Field Detail

VERSION_JSON_FEED_1

public static final java.lang.String VERSION_JSON_FEED_1

See Also:

Constant Field Values

VERSION_JSON_FEED_1_1

public static final java.lang.String VERSION_JSON_FEED_1_1

See Also:

Constant Field Values

KEY_VERSION

public static final java.lang.String KEY_VERSION

See Also:

Constant Field Values

KEY_TITLE

public static final java.lang.String KEY_TITLE

See Also:

Constant Field Values

KEY_HOME_PAGE_URL

public static final java.lang.String KEY_HOME_PAGE_URL

See Also:

Constant Field Values

KEY_FEED_URL

public static final java.lang.String KEY_FEED_URL

See Also:

Constant Field Values

KEY_DESCRIPTION

public static final java.lang.String KEY_DESCRIPTION

See Also:

Constant Field Values

KEY_USER_COMMENT

public static final java.lang.String KEY_USER_COMMENT

See Also:

Constant Field Values

KEY_NEXT_URL

public static final java.lang.String KEY_NEXT_URL

See Also:

Constant Field Values

KEY_ICON

public static final java.lang.String KEY_ICON

See Also:

Constant Field Values

KEY_FAVICON

public static final java.lang.String KEY_FAVICON

See Also:

Constant Field Values

KEY_AUTHORS

public static final java.lang.String KEY_AUTHORS

See Also:

Constant Field Values

KEY_ITEMS

public static final java.lang.String KEY_ITEMS

See Also:

Constant Field Values

KEY_AUTHOR

public static final java.lang.String KEY_AUTHOR

See Also:

Constant Field Values

KEY_LANGUAGE

public static final java.lang.String KEY_LANGUAGE

See Also:

Constant Field Values

KEY_EXPIRED

public static final java.lang.String KEY_EXPIRED

See Also:

Constant Field Values

KEY_HUBS

public static final java.lang.String KEY_HUBS

See Also:

Constant Field Values

Constructor Detail

JsonFeed

public JsonFeed()

Method Detail

builder

@NonNull
public static JsonFeed.Builder builder()

Returns:

JSON Feed Builder

builder

@NonNull
public static JsonFeed.Builder builder(@NonNull
                                                java.lang.String title,
                                                @NonNull
                                                java.util.List<JsonFeedItem> items)

Creates builder with required fields.

Parameters:

title - JSON Feed's title

items - JSON Feed's items

Returns:

JSON Feed Builder

builder

@NonNull
public static JsonFeed.Builder builder(@NonNull
                                                java.lang.String version,
                                                @NonNull
                                                java.lang.String title,
                                                @NonNull
                                                java.util.List<JsonFeedItem> items)

Parameters:

version - JSON Feed version

title - JSON Feed's title

items - JSON Feed's items

Returns:

JSON Feed Builder

setVersion

public void setVersion(@NonNull
                       java.lang.String version)

URL of the version of the format the feed uses.

Parameters:

version - of JSON feed

getVersion

@NonNull
public java.lang.String getVersion()

Returns the URL of the version of the format the feed uses.

Returns:

version of JSON feed

getTitle

@NonNull
public java.lang.String getTitle()

The name of the feed, which will often correspond to the name of the website.

Returns:

the name of the feed

setTitle

public void setTitle(@NonNull
                     java.lang.String title)

The name of the feed, which will often correspond to the name of the website.

Parameters:

title - the name of the feed

getHomePageUrl

@Nullable
public java.lang.String getHomePageUrl()

The URL of the resource that the feed describes. This resource may or may not actually be a “home” page, but it should be an HTML page

Returns:

The URL of the resource that the feed describes

setHomePageUrl

public void setHomePageUrl(@Nullable
                           java.lang.String homePageUrl)

The URL of the resource that the feed describes. This resource may or may not actually be a “home” page, but it should be an HTML page

Parameters:

homePageUrl - The URL of the resource that the feed describes

getDescription

public java.lang.String getDescription()

Detail on what the feed is about. A feed reader may display this text.

Returns:

detail on what the feed is about

setDescription

public void setDescription(java.lang.String description)

Detail on what the feed is about. A feed reader may display this text.

Parameters:

description - detail on what the feed is about

getFeedUrl

@Nullable
public java.lang.String getFeedUrl()

The URL of the feed, and serves as the unique identifier for the feed.

Returns:

the URL of the feed, and serves as the unique identifier for the feed

setFeedUrl

public void setFeedUrl(@Nullable
                       java.lang.String feedUrl)

The URL of the feed, and serves as the unique identifier for the feed.

Parameters:

feedUrl - the URL of the feed, and serves as the unique identifier for the feed

getUserComment

@Nullable
public java.lang.String getUserComment()

Description of the purpose of the feed. This is for the use of people looking at the raw JSON, and should be ignored by feed readers

Returns:

description of the purpose of the feed.

setUserComment

public void setUserComment(@Nullable
                           java.lang.String userComment)

Description of the purpose of the feed. This is for the use of people looking at the raw JSON, and should be ignored by feed readers

Parameters:

userComment - description of the purpose of the feed.

getNextURL

@Nullable
public java.lang.String getNextURL()

The URL of a feed that provides the next n items, where n is determined by the publisher. This allows for pagination, but with the expectation that reader software is not required to use it and probably won’t use it very often

Returns:

the URL of a feed that provides the next n items

setNextURL

public void setNextURL(@Nullable
                       java.lang.String nextURL)

The URL of a feed that provides the next n items, where n is determined by the publisher. This allows for pagination, but with the expectation that reader software is not required to use it and probably won’t use it very often

Parameters:

nextURL - the URL of a feed that provides the next n items

getIcon

@Nullable
public java.lang.String getIcon()

The URL of an image for the feed suitable to be used in a timeline, much the way an avatar might be used. It should be square and relatively large — such as 512 x 512 pixels

Returns:

the URL of an image for the feed suitable to be used in a timeline

setIcon

public void setIcon(@Nullable
                    java.lang.String icon)

The URL of an image for the feed suitable to be used in a timeline, much the way an avatar might be used. It should be square and relatively large — such as 512 x 512 pixels

Parameters:

icon - the URL of an image for the feed suitable to be used in a timeline

getFavicon

@Nullable
public java.lang.String getFavicon()

The URL of an image for the feed suitable to be used in a source list. It should be square and relatively small, but not smaller than 64 x 64 pixels

Returns:

the URL of an image for the feed suitable to be used in a source list

setFavicon

public void setFavicon(@Nullable
                       java.lang.String favicon)

The URL of an image for the feed suitable to be used in a source list. It should be square and relatively small, but not smaller than 64 x 64 pixels

Parameters:

favicon - the URL of an image for the feed suitable to be used in a source list

getAuthors

public java.util.List<JsonFeedAuthor> getAuthors()

Specifies one or more feed authors. The author object has several members

Returns:

specifies one or more feed authors

setAuthors

public void setAuthors(@Nullable
                       java.util.List<JsonFeedAuthor> authors)

Specifies one or more feed authors. The author object has several members

Parameters:

authors - specifies one or more feed authors

getLanguage

@Nullable
public java.lang.String getLanguage()

The primary language for the feed in the format specified in RFC 5646.

Returns:

the primary language for the feed

setLanguage

public void setLanguage(@Nullable
                        java.lang.String language)

The primary language for the feed in the format specified in RFC 5646.

Parameters:

language - the primary language for the feed

getExpired

@Nullable
public java.lang.Boolean getExpired()

Says whether or not the feed is finished — that is, whether or not it will ever update again.

Returns:

expired says whether or not the feed is finished

setExpired

public void setExpired(@Nullable
                       java.lang.Boolean expired)

Says whether or not the feed is finished — that is, whether or not it will ever update again.

Parameters:

expired - says whether or not the feed is finished

getHubs

@Nullable
public java.util.List<JsonHub> getHubs()

Describes endpoints that can be used to subscribe to real-time notifications from the publisher of this feed.

Returns:

Describes endpoints that can be used to subscribe to real-time notifications

setHubs

public void setHubs(@Nullable
                    java.util.List<JsonHub> hubs)

Describes endpoints that can be used to subscribe to real-time notifications from the publisher of this feed.

Parameters:

hubs - Describes endpoints that can be used to subscribe to real-time notifications

addHub

public void addHub(@NonNull
                   JsonHub hub)

Parameters:

hub - Endpoint that can be used to subscribe to real-time notifications from the publisher of this feed.

getItems

@NonNull
public java.util.List<JsonFeedItem> getItems()

The items in the field.

Returns:

list of items in the feed

setItems

public void setItems(@NonNull
                     java.util.List<JsonFeedItem> items)

The items in the field.

Parameters:

items - list of items in the feed

addAuthor

public void addAuthor(@NonNull
                      JsonFeedAuthor author)

Parameters:

author - Global JSON Feed's author

addItem

public void addItem(@NonNull
                    JsonFeedItem item)

Parameters:

item - JSON Feed's item

toMap

@NonNull
public java.util.Map<java.lang.String,java.lang.Object> toMap()

Returns:

Map representation of Object.