io.micronaut.rss.jsonfeed

Class JsonFeedItem.Builder

java.lang.Object

io.micronaut.rss.jsonfeed.JsonFeedItem.Builder

Enclosing class:

JsonFeedItem

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

JSON Feed Item Builder.

Method Summary

Modifier and Type	Method and Description
JsonFeedItem.Builder	attachment(JsonFeedAttachment attachment) Attachments associated with the item.
JsonFeedItem.Builder	author(JsonFeedAuthor author) Adds an author to the feed.
JsonFeedItem.Builder	bannerImage(java.lang.String bannerImage) The URL of an image to use as a banner.
JsonFeedItem	build()
JsonFeedItem.Builder	contentHtml(java.lang.String contentHtml) The html content of the item in the feed.
JsonFeedItem.Builder	contentText(java.lang.String contentText) The text content of the item in the feed.
JsonFeedItem.Builder	dateModified(java.lang.String dateModified) Specifies the last modified date in RFC 3339.
JsonFeedItem.Builder	dateModified(java.time.ZonedDateTime dateModified) Specifies the last modified date in RFC 3339.
JsonFeedItem.Builder	datePublished(java.lang.String datePublished) Specifies the publishing date in RFC 3339.
JsonFeedItem.Builder	datePublished(java.time.ZonedDateTime datePublished) Specifies the publishing date in RFC 3339.
JsonFeedItem.Builder	externalUrl(java.lang.String externalUrl) The URL of a page elsewhere.
JsonFeedItem.Builder	id(java.lang.String id)
JsonFeedItem.Builder	image(java.lang.String image) The URL of the main image for the item.
JsonFeedItem.Builder	language(RssLanguage language) The primary language for the feed in the format specified in RFC 5646.
JsonFeedItem.Builder	summary(java.lang.String summary) Plain text sentence or two describing the item.
JsonFeedItem.Builder	tag(java.lang.String tag) Associate a tag with the item.
JsonFeedItem.Builder	title(java.lang.String title) Title of the item in feed.
JsonFeedItem.Builder	url(java.lang.String url) The URL of the resource described by the item.

Methods inherited from class java.lang.Object

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

Method Detail

id

@NonNull
public JsonFeedItem.Builder id(@NonNull
                                        java.lang.String id)

Parameters:

id - unique for the item for that feed over time.

Returns:

The Builder

url

@NonNull
public JsonFeedItem.Builder url(java.lang.String url)

The URL of the resource described by the item. It’s the permalink.

Parameters:

url - the URL of the resource described by the item

Returns:

Builder

externalUrl

@NonNull
public JsonFeedItem.Builder externalUrl(java.lang.String externalUrl)

The URL of a page elsewhere. This is especially useful for linkblogs

Parameters:

externalUrl - the URL of a page

Returns:

Builder

title

@NonNull
public JsonFeedItem.Builder title(java.lang.String title)

Title of the item in feed.

Parameters:

title - title of the item in feed

Returns:

Builder

contentHtml

@NonNull
public JsonFeedItem.Builder contentHtml(java.lang.String contentHtml)

The html content of the item in the feed.

Parameters:

contentHtml - the html content of the item in the feed

Returns:

Builder

contentText

@NonNull
public JsonFeedItem.Builder contentText(java.lang.String contentText)

The text content of the item in the feed.

Parameters:

contentText - the text content of the item in the feed

Returns:

Builder

summary

@NonNull
public JsonFeedItem.Builder summary(java.lang.String summary)

Plain text sentence or two describing the item.

Parameters:

summary - plain text sentence or two describing the item

Returns:

Builder

image

@NonNull
public JsonFeedItem.Builder image(java.lang.String image)

The URL of the main image for the item.

Parameters:

image - the URL of the main image for the item

Returns:

Builder

bannerImage

@NonNull
public JsonFeedItem.Builder bannerImage(java.lang.String bannerImage)

The URL of an image to use as a banner.

Parameters:

bannerImage - the URL of an image to use as a banner

Returns:

Builder

datePublished

@NonNull
public JsonFeedItem.Builder datePublished(java.time.ZonedDateTime datePublished)

Specifies the publishing date in RFC 3339.

Parameters:

datePublished - specifies the publishing date in RFC 3339

Returns:

Builder

datePublished

@NonNull
public JsonFeedItem.Builder datePublished(java.lang.String datePublished)

Specifies the publishing date in RFC 3339.

Parameters:

datePublished - specifies the publishing date in RFC 3339

Returns:

Builder

dateModified

@NonNull
public JsonFeedItem.Builder dateModified(java.lang.String dateModified)

Specifies the last modified date in RFC 3339.

Parameters:

dateModified - specifies the last modified date in RFC 3339

Returns:

Builder

dateModified

@NonNull
public JsonFeedItem.Builder dateModified(java.time.ZonedDateTime dateModified)

Specifies the last modified date in RFC 3339.

Parameters:

dateModified - specifies the last modified date in RFC 3339

Returns:

Builder

author

@NonNull
public JsonFeedItem.Builder author(JsonFeedAuthor author)

Adds an author to the feed.

Parameters:

author - An author of the feed

Returns:

Builder

tag

@NonNull
public JsonFeedItem.Builder tag(@NonNull
                                         java.lang.String tag)

Associate a tag with the item.

Parameters:

tag - associate a tag with the item

Returns:

Builder

language

@NonNull
public JsonFeedItem.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

attachment

@NonNull
public JsonFeedItem.Builder attachment(@NonNull
                                                JsonFeedAttachment attachment)

Attachments associated with the item.

Parameters:

attachment - attachments associated with the item

Returns:

Builder

build

@NonNull
public JsonFeedItem build()