io.micronaut.rss.jsonfeed

Class JsonFeed.Builder

java.lang.Object

io.micronaut.rss.jsonfeed.JsonFeed.Builder

Enclosing class:

JsonFeed

public static final class JsonFeed.Builder
extends java.lang.Object

JSON Feed Builder.

Method Summary

Modifier and Type	Method and Description
JsonFeed.Builder	author(JsonFeedAuthor author) Adds an author to the feed.
JsonFeed	build()
JsonFeed.Builder	description(java.lang.String description) Detail on what the feed is about.
JsonFeed.Builder	expired(java.lang.Boolean expired) Says whether or not the feed is finished — that is, whether or not it will ever update again.
JsonFeed.Builder	favicon(java.lang.String favicon) The URL of an image for the feed suitable to be used in a source list.
JsonFeed.Builder	feedUrl(java.lang.String feedUrl) The URL of the feed, and serves as the unique identifier for the feed.
JsonFeed.Builder	homePageUrl(java.lang.String homePageUrl) The URL of the resource that the feed describes.
JsonFeed.Builder	hub(JsonHub hub) Describes endpoints that can be used to subscribe to real-time notifications from the publisher of this feed.
JsonFeed.Builder	icon(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.
JsonFeed.Builder	item(JsonFeedItem item) Content of the feed.
JsonFeed.Builder	items(java.util.List<JsonFeedItem> items)
JsonFeed.Builder	language(RssLanguage language) The primary language for the feed in the format specified in RFC 5646.
JsonFeed.Builder	language(java.lang.String language) The primary language for the feed in the format specified in RFC 5646.
JsonFeed.Builder	nextUrl(java.lang.String nextURL) The URL of a feed that provides the next n items, where n is determined by the publisher.
JsonFeed.Builder	title(java.lang.String title) The name of the feed, which will often correspond to the name of the website.
JsonFeed.Builder	userComment(java.lang.String userComment) Description of the purpose of the feed.
JsonFeed.Builder	version(java.lang.String version)

Methods inherited from class java.lang.Object

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

Method Detail

build

@NonNull
public JsonFeed build()

version

@NonNull
public JsonFeed.Builder version(@NonNull
                                         java.lang.String version)

title

@NonNull
public JsonFeed.Builder title(@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

Returns:

Builder

homePageUrl

@NonNull
public JsonFeed.Builder homePageUrl(@NonNull
                                             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

Returns:

Builder

feedUrl

@NonNull
public JsonFeed.Builder feedUrl(@NonNull
                                         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

Returns:

Builder

description

@NonNull
public JsonFeed.Builder description(@NonNull
                                             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

Returns:

Builder

userComment

@NonNull
public JsonFeed.Builder userComment(@NonNull
                                             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.

Returns:

Builder

nextUrl

@NonNull
public JsonFeed.Builder nextUrl(@NonNull
                                         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

Returns:

Builder

icon

@NonNull
public JsonFeed.Builder icon(@NonNull
                                      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

Returns:

Builder

favicon

@NonNull
public JsonFeed.Builder favicon(@NonNull
                                         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

Returns:

Builder

item

@NonNull
public JsonFeed.Builder item(@NonNull
                                      JsonFeedItem item)

Content of the feed.

Parameters:

item - content of the feed

Returns:

Builder

author

@NonNull
public JsonFeed.Builder author(@NonNull
                                        JsonFeedAuthor author)

Adds an author to the feed.

Parameters:

author - An author of the feed

Returns:

Builder

language

@NonNull
public JsonFeed.Builder language(@NonNull
                                          RssLanguage language)

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

Parameters:

language - the primary language for the feed

Returns:

Builder

language

@NonNull
public JsonFeed.Builder language(@NonNull
                                          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

Returns:

Builder

expired

@NonNull
public JsonFeed.Builder expired(@NonNull
                                         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

Returns:

Builder

hub

@NonNull
public JsonFeed.Builder hub(@NonNull
                                     JsonHub hub)

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

Parameters:

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

Returns:

Builder

items

@NonNull
public JsonFeed.Builder items(@NonNull
                                       java.util.List<JsonFeedItem> items)

Parameters:

items - Feed items

Returns:

The Builder.