io.micronaut.rss.jsonfeed

Class JsonFeedItem

java.lang.Object

io.micronaut.rss.jsonfeed.JsonFeedItem

@Introspected
public class JsonFeedItem
extends java.lang.Object

Object in a JSON Feed.

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	JsonFeedItem.Builder JSON Feed Item Builder.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_ATTACHMENTS
static java.lang.String	KEY_AUTHORS
static java.lang.String	KEY_BANNER_IMAGE
static java.lang.String	KEY_CONTENT_HTML
static java.lang.String	KEY_CONTENT_TEXT
static java.lang.String	KEY_DATE_MODIFIED
static java.lang.String	KEY_DATE_PUBLISHED
static java.lang.String	KEY_EXTERNAL_URL
static java.lang.String	KEY_ID
static java.lang.String	KEY_IMAGE
static java.lang.String	KEY_LANGUAGE
static java.lang.String	KEY_SUMMARY
static java.lang.String	KEY_TAGS
static java.lang.String	KEY_TITLE
static java.lang.String	KEY_URL

Constructor Summary

Constructors

Constructor and Description
JsonFeedItem()

Method Summary

Modifier and Type	Method and Description
void	addAttachment(JsonFeedAttachment attachment)
void	addAuthor(JsonFeedAuthor author)
void	addTag(java.lang.String tag)
static JsonFeedItem.Builder	builder()
static JsonFeedItem.Builder	builder(java.lang.String id)
java.util.List<JsonFeedAttachment>	getAttachments() Attachments associated with the item.
java.util.List<JsonFeedAuthor>	getAuthors() List of authors of the item.
java.lang.String	getBannerImage() The URL of an image to use as a banner.
java.lang.String	getContentHtml() The html content of the item in the feed.
java.lang.String	getContentText() The text content of the item in the feed.
java.lang.String	getDateModified() Specifies the last modified date in RFC 3339.
java.lang.String	getDatePublished() Specifies the publishing date in RFC 3339.
java.lang.String	getExternalUrl() The URL of a page elsewhere.
java.lang.String	getId() Unique id for that item for that feed over time.
java.lang.String	getImage() The URL of the main image for the item.
RssLanguage	getLanguage() The primary language for the item in the format specified in RFC 5646.
java.lang.String	getSummary() Plain text sentence or two describing the item.
java.util.List<java.lang.String>	getTags() Tags associated with the item.
java.lang.String	getTitle() Title of the item in feed.
java.lang.String	getUrl() The URL of the resource described by the item.
void	setAttachments(java.util.List<JsonFeedAttachment> attachments) Attachments associated with the item.
void	setAuthors(java.util.List<JsonFeedAuthor> authors) List of authors of the item.
void	setBannerImage(java.lang.String bannerImage) The URL of an image to use as a banner.
void	setContentHtml(java.lang.String contentHtml) The html content of the item in the feed.
void	setContentText(java.lang.String contentText) The text content of the item in the feed.
void	setDateModified(java.lang.String dateModified) Specifies the last modified date in RFC 3339.
void	setDatePublished(java.lang.String datePublished) Specifies the publishing date in RFC 3339.
void	setExternalUrl(java.lang.String externalUrl) The URL of a page elsewhere.
void	setId(java.lang.String id) Unique id for that item for that feed over time.
void	setImage(java.lang.String image) The URL of the main image for the item.
void	setLanguage(RssLanguage language) The primary language for the item in the format specified in RFC 5646.
void	setSummary(java.lang.String summary) Plain text sentence or two describing the item.
void	setTags(java.util.List<java.lang.String> tags) Tags associated with the item.
void	setTitle(java.lang.String title) Title of the item in feed.
void	setUrl(java.lang.String url) The URL of the resource described by the item.
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

KEY_ID

public static final java.lang.String KEY_ID

See Also:

Constant Field Values

KEY_URL

public static final java.lang.String KEY_URL

See Also:

Constant Field Values

KEY_EXTERNAL_URL

public static final java.lang.String KEY_EXTERNAL_URL

See Also:

Constant Field Values

KEY_TITLE

public static final java.lang.String KEY_TITLE

See Also:

Constant Field Values

KEY_CONTENT_HTML

public static final java.lang.String KEY_CONTENT_HTML

See Also:

Constant Field Values

KEY_CONTENT_TEXT

public static final java.lang.String KEY_CONTENT_TEXT

See Also:

Constant Field Values

KEY_SUMMARY

public static final java.lang.String KEY_SUMMARY

See Also:

Constant Field Values

KEY_IMAGE

public static final java.lang.String KEY_IMAGE

See Also:

Constant Field Values

KEY_BANNER_IMAGE

public static final java.lang.String KEY_BANNER_IMAGE

See Also:

Constant Field Values

KEY_DATE_PUBLISHED

public static final java.lang.String KEY_DATE_PUBLISHED

See Also:

Constant Field Values

KEY_DATE_MODIFIED

public static final java.lang.String KEY_DATE_MODIFIED

See Also:

Constant Field Values

KEY_AUTHORS

public static final java.lang.String KEY_AUTHORS

See Also:

Constant Field Values

KEY_TAGS

public static final java.lang.String KEY_TAGS

See Also:

Constant Field Values

KEY_LANGUAGE

public static final java.lang.String KEY_LANGUAGE

See Also:

Constant Field Values

KEY_ATTACHMENTS

public static final java.lang.String KEY_ATTACHMENTS

See Also:

Constant Field Values

Constructor Detail

JsonFeedItem

public JsonFeedItem()

Method Detail

builder

public static JsonFeedItem.Builder builder()

Returns:

A Builder to build a JsonFeedItem.

builder

public static JsonFeedItem.Builder builder(java.lang.String id)

Parameters:

id - Id of the feed entry

Returns:

A Builder to build a JsonFeedItem.

getId

@NonNull
public java.lang.String getId()

Unique id for that item for that feed over time. If an item is ever updated, the id should be unchanged

Returns:

unique id of the item

setId

public void setId(@NonNull
                  java.lang.String id)

Unique id for that item for that feed over time. If an item is ever updated, the id should be unchanged

Parameters:

id - unique id of the item

getUrl

@Nullable
public java.lang.String getUrl()

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

Returns:

the URL of the resource described by the item

setUrl

public void setUrl(@Nullable
                   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

getExternalUrl

@Nullable
public java.lang.String getExternalUrl()

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

Returns:

the URL of a page

setExternalUrl

public void setExternalUrl(@Nullable
                           java.lang.String externalUrl)

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

Parameters:

externalUrl - the URL of a page

getTitle

@Nullable
public java.lang.String getTitle()

Title of the item in feed.

Returns:

title of the item in feed

setTitle

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

Title of the item in feed.

Parameters:

title - title of the item in feed

getContentHtml

@Nullable
public java.lang.String getContentHtml()

The html content of the item in the feed.

Returns:

the html content of the item in the feed

setContentHtml

public void setContentHtml(@Nullable
                           java.lang.String contentHtml)

The html content of the item in the feed.

Parameters:

contentHtml - the html content of the item in the feed

getContentText

@Nullable
public java.lang.String getContentText()

The text content of the item in the feed.

Returns:

the text content of the item in the feed

setContentText

public void setContentText(@Nullable
                           java.lang.String contentText)

The text content of the item in the feed.

Parameters:

contentText - the text content of the item in the feed

getSummary

@Nullable
public java.lang.String getSummary()

Plain text sentence or two describing the item.

Returns:

plain text sentence or two describing the item

setSummary

public void setSummary(@Nullable
                       java.lang.String summary)

Plain text sentence or two describing the item.

Parameters:

summary - plain text sentence or two describing the item

getImage

@Nullable
public java.lang.String getImage()

The URL of the main image for the item.

Returns:

the URL of the main image for the item

setImage

public void setImage(@Nullable
                     java.lang.String image)

The URL of the main image for the item.

Parameters:

image - the URL of the main image for the item

getBannerImage

@Nullable
public java.lang.String getBannerImage()

The URL of an image to use as a banner.

Returns:

the URL of an image to use as a banner

setBannerImage

public void setBannerImage(@Nullable
                           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

getDatePublished

@Nullable
public java.lang.String getDatePublished()

Specifies the publishing date in RFC 3339.

Returns:

specifies the publishing date in RFC 3339

setDatePublished

public void setDatePublished(@Nullable
                             java.lang.String datePublished)

Specifies the publishing date in RFC 3339.

Parameters:

datePublished - specifies the publishing date in RFC 3339

getDateModified

@Nullable
public java.lang.String getDateModified()

Specifies the last modified date in RFC 3339.

Returns:

specifies the last modified date in RFC 3339

setDateModified

public void setDateModified(@Nullable
                            java.lang.String dateModified)

Specifies the last modified date in RFC 3339.

Parameters:

dateModified - specifies the last modified date in RFC 3339

getAuthors

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

List of authors of the item.

Returns:

list of authors of the item

setAuthors

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

List of authors of the item.

Parameters:

authors - list of authors of the item

getTags

@Nullable
public java.util.List<java.lang.String> getTags()

Tags associated with the item.

Returns:

tags associated with the item

setTags

public void setTags(@Nullable
                    java.util.List<java.lang.String> tags)

Tags associated with the item.

Parameters:

tags - associated tags with the item

getLanguage

@Nullable
public RssLanguage getLanguage()

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

Returns:

the primary language for the feed

setLanguage

public void setLanguage(@Nullable
                        RssLanguage language)

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

Parameters:

language - the primary language for the feed

getAttachments

@Nullable
public java.util.List<JsonFeedAttachment> getAttachments()

Attachments associated with the item.

Returns:

attachments associated with the item

setAttachments

public void setAttachments(@Nullable
                           java.util.List<JsonFeedAttachment> attachments)

Attachments associated with the item.

Parameters:

attachments - attachments associated with the item

addAuthor

public void addAuthor(@NonNull
                      JsonFeedAuthor author)

Parameters:

author - JSON Feed Item's Author

addAttachment

public void addAttachment(JsonFeedAttachment attachment)

Parameters:

attachment - JSON Feed Item's Attachment

addTag

public void addTag(@NonNull
                   java.lang.String tag)

Parameters:

tag - JSON Feed Item's tag

toMap

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

Returns:

Map representation of object.