Feed (Podcast Feed Parser 0.9.0 API)

java.lang.Object
- be.ceau.podcastparser.models.core.Feed

```
public class Feed
extends Object
```

Constructor Summary

Constructors
Constructor and Description

Feed()

Constructors
Constructor and Description
`Feed()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAuthor(Person author)`
`void`	`addCategory(Category category)`
`void`	`addContributor(Person contributor)`
`void`	`addImage(Image image)`
`void`	`addItem(Item item)`
`void`	`addKeyword(String keyword)`
`void`	`addKeywords(Collection<String> keywords)`
`void`	`addLink(Link link)`
`void`	`addOtherValue(OtherValueKey key, String value)`
`void`	`addSkipDay(String skipDay)`
`void`	`addSkipHour(int skipHour)`
`List<Person>`	`getAuthors()` Artist(s) or author(s) of the feed.
`boolean`	`getBlock()`
`TypedString`	`getBrowserFriendly()`
`Set<Category>`	`getCategories()` Specify one or more categories that the channel belongs to.
`String`	`getCloud()` Allows processes to register with a cloud to be notified of updates to the channel, implementing a lightweight publish-subscribe protocol for RSS feeds.
`List<Person>`	`getContributors()`
`Copyright`	`getCopyright()` Copyright notice for content in the channel.
`Credit`	`getCredit()`
`TypedString`	`getDescription()` Phrase or sentence describing the channel.
`String`	`getDocs()` A URL that points to the documentation for the format used in the RSS file.
`String`	`getEmail()` `String` email for this `Feed`
`String`	`getGenerator()` A `String` indicating the program used to generate the channel.
`GeoPoint`	`getGeoPoint()` `GeoPoint` for this `Item`
`String`	`getId()` The `id` element conveys a permanent, universally unique identifier for an entry or feed.
`List<Image>`	`getImages()` Specifies a GIF, JPEG or PNG image that can be displayed with the channel.
`List<Item>`	`getItems()` An item may represent a "story" -- much like a story in a newspaper or magazine; if so its description is a synopsis of the story, and the link points to the full story.
`Set<String>`	`getKeywords()` Not in RSS specification.
`String`	`getLanguage()` The language the channel is written in.
`ZonedDateTime`	`getLastBuildDate()` The last time the content of the channel changed.
`Set<Link>`	`getLinks()` Collection of all links defined at the feed or channel level.
`String`	`getLocation()` The geographic location for this feed.
`String`	`getManagingEditor()` Email address for person responsible for editorial content.
`Map<OtherValueKey,String>`	`getOtherValues()` A `Map` containing any value present in the podcast XML that is not mapped to any of the other values present here.
`Person`	`getOwner()` Information that can be used to contact the owner of the podcast for communication specifically about their podcast.
`ZonedDateTime`	`getPubDate()` The publication date for the content in the channel.
`Rating`	`getRating()` The rating for this item.
`List<String>`	`getSkipDays()` A hint for aggregators telling them which days they can skip.
`List<Integer>`	`getSkipHours()` A hint for aggregators telling them which hours they can skip.
`String`	`getSubtitle()` Description of the feed.
`String`	`getSummary()`
`String`	`getTextInput()` Specifies a text input box that can be displayed with the channel.
`String`	`getTitle()` The name of the channel or feed
`Duration`	`getTtl()` TTL stands for time to live.
`String`	`getType()`
`UpdateInfo`	`getUpdateInfo()` Update information for this feed.
`String`	`getWebMaster()` Email address for person responsible for technical issues relating to channel.
`boolean`	`isComplete()`
`void`	`setBlock(boolean block)`
`void`	`setBrowserFriendly(TypedString browserFriendly)`
`void`	`setCloud(String cloud)`
`void`	`setComplete(boolean complete)`
`void`	`setCopyright(Copyright copyright)`
`void`	`setCredit(Credit credit)`
`void`	`setDescription(TypedString description)`
`void`	`setDocs(String docs)`
`void`	`setEmail(String email)`
`void`	`setGenerator(String generator)`
`void`	`setGeoPoint(GeoPoint geoPoint)`
`void`	`setId(String id)`
`void`	`setLanguage(String language)`
`void`	`setLastBuildDate(ZonedDateTime lastBuildDate)`
`void`	`setLatitude(BigDecimal latitude)`
`void`	`setLocation(String location)`
`void`	`setLongitude(BigDecimal longitude)`
`void`	`setManagingEditor(String managingEditor)`
`void`	`setOwner(Person owner)`
`void`	`setPubDate(ZonedDateTime pubDate)`
`void`	`setRating(Rating rating)`
`void`	`setSubtitle(String subtitle)`
`void`	`setSummary(String summary)`
`void`	`setTextInput(String textInput)`
`void`	`setTitle(String title)`
`void`	`setTtl(Duration ttl)`
`void`	`setType(String type)`
`void`	`setUpdateBase(ZonedDateTime base)`
`void`	`setUpdateFrequency(Integer frequency)`
`void`	`setUpdateInfo(UpdateInfo updateInfo)`
`void`	`setUpdatePeriod(String period)`
`void`	`setWebMaster(String webMaster)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Feed
```
public Feed()
```
- Method Detail
  - getId
```
public String getId()
```
    The id element conveys a permanent, universally unique identifier for an entry or feed.
    
    Part of Atom specification. Not listed in RSS specification.
    
    Returns:
    
    a String or null
  - setId
```
public void setId(String id)
```
  - getTitle
```
public String getTitle()
```
    The name of the channel or feed
    
    Returns:
    
    a String or null
  - setTitle
```
public void setTitle(String title)
```
  - getLinks
```
public Set<Link> getLinks()
```
    Collection of all links defined at the feed or channel level.
    
    Required in RSS specification. Listed in Atom specification as element link.
    
    Returns:
    
    a Set, never null
  - addLink
```
public void addLink(Link link)
```
  - getDescription
```
public TypedString getDescription()
```
    Phrase or sentence describing the channel.
    
    Returns:
    
    a TypedString or null
  - setDescription
```
public void setDescription(TypedString description)
```
  - getItems
```
public List<Item> getItems()
```
    An item may represent a "story" -- much like a story in a newspaper or magazine; if so its description is a synopsis of the story, and the link points to the full story. An item may also be complete in itself, if so, the description contains the text (entity-encoded HTML is allowed), and the link and title may be omitted. All elements of an item are optional, however at least one of title or description must be present.
    
    Returns:
    
    List of Item instances, never null
  - addItem
```
public void addItem(Item item)
```
  - getLanguage
```
public String getLanguage()
```
    The language the channel is written in.
    
    Returns:
    
    String or null
  - setLanguage
```
public void setLanguage(String language)
```
  - getCopyright
```
public Copyright getCopyright()
```
    Copyright notice for content in the channel.
    
    Returns:
    
    Copyright instance or null
  - setCopyright
```
public void setCopyright(Copyright copyright)
```
  - getManagingEditor
```
public String getManagingEditor()
```
    Email address for person responsible for editorial content.
    
    Returns:
    
    String or null
  - setManagingEditor
```
public void setManagingEditor(String managingEditor)
```
  - getWebMaster
```
public String getWebMaster()
```
    Email address for person responsible for technical issues relating to channel.
    
    Returns:
    
    String or null
  - setWebMaster
```
public void setWebMaster(String webMaster)
```
  - getPubDate
```
public ZonedDateTime getPubDate()
```
    The publication date for the content in the channel. For example, the New York Times publishes on a daily basis, the publication date flips once every 24 hours. That's when the pubDate of the channel changes. All date-times in RSS conform to the Date and Time Specification of RFC 822, with the exception that the year may be expressed with two characters or four characters (four preferred).
    
    Returns:
    
    ZonedDateTime or null
  - setPubDate
```
public void setPubDate(ZonedDateTime pubDate)
```
  - getLastBuildDate
```
public ZonedDateTime getLastBuildDate()
```
    The last time the content of the channel changed.
    
    Optional in RSS specification. Listed in Atom specification as element updated.
    
    Returns:
    
    ZonedDateTime or null
  - setLastBuildDate
```
public void setLastBuildDate(ZonedDateTime lastBuildDate)
```
  - getCategories
```
public Set<Category> getCategories()
```
    Specify one or more categories that the channel belongs to. Follows the same rules as the Item-level category element.
    
    Returns:
    
    a Set of Category instances, never null, never containing null
  - addCategory
```
public void addCategory(Category category)
```
  - getGenerator
```
public String getGenerator()
```
    A String indicating the program used to generate the channel.
    
    Returns:
    
    String or null
  - setGenerator
```
public void setGenerator(String generator)
```
  - getDocs
```
public String getDocs()
```
    A URL that points to the documentation for the format used in the RSS file. It's probably a pointer to this page. It's for people who might stumble across an RSS file on a Web server 25 years from now and wonder what it is.
    
    Returns:
    
    String or null
  - setDocs
```
public void setDocs(String docs)
```
  - getCloud
```
public String getCloud()
```
    Allows processes to register with a cloud to be notified of updates to the channel, implementing a lightweight publish-subscribe protocol for RSS feeds.
    
    Returns:
    
    String or null
  - setCloud
```
public void setCloud(String cloud)
```
  - getTtl
```
public Duration getTtl()
```
    TTL stands for time to live. It's a number of minutes that indicates how long a channel can be cached before refreshing from the source.
    
    Optional in RSS specification.
    
    Returns:
    
    Duration or null
  - setTtl
```
public void setTtl(Duration ttl)
```
  - getImages
```
public List<Image> getImages()
```
    Specifies a GIF, JPEG or PNG image that can be displayed with the channel.
    
    Returns:
    
    a List, never null
  - addImage
```
public void addImage(Image image)
```
  - getTextInput
```
public String getTextInput()
```
    Specifies a text input box that can be displayed with the channel.
    
    Returns:
    
    String or null
  - setTextInput
```
public void setTextInput(String textInput)
```
  - getSkipHours
```
public List<Integer> getSkipHours()
```
    A hint for aggregators telling them which hours they can skip.
    
    Returns:
    
    a List, never null
  - addSkipHour
```
public void addSkipHour(int skipHour)
```
  - getSkipDays
```
public List<String> getSkipDays()
```
    A hint for aggregators telling them which days they can skip.
    
    Returns:
    
    a List, never null
  - addSkipDay
```
public void addSkipDay(String skipDay)
```
  - getSubtitle
```
public String getSubtitle()
```
    Description of the feed.
    
    Not in RSS specification. Listed in iTunes RSS spec.
    
    Returns:
    
    String or null
  - setSubtitle
```
public void setSubtitle(String subtitle)
```
  - getAuthors
```
public List<Person> getAuthors()
```
    Artist(s) or author(s) of the feed.
    
    Not in RSS specification. Listed in Atom spec and iTunes spec.
    
    Returns:
    
    a List of Person instances, never null
  - addAuthor
```
public void addAuthor(Person author)
```
  - getOwner
```
public Person getOwner()
```
    Information that can be used to contact the owner of the podcast for communication specifically about their podcast.
    
    Not in RSS specification. Listed in iTunes RSS spec.
    
    Returns:
    
    Person or null
  - setOwner
```
public void setOwner(Person owner)
```
  - getContributors
```
public List<Person> getContributors()
```
    Returns:
    
    a List of Person instances, never null
  - addContributor
```
public void addContributor(Person contributor)
```
  - getKeywords
```
public Set<String> getKeywords()
```
    Not in RSS specification. Listed in iTunes RSS spec.
    
    Returns:
    
    a Set, never null
  - addKeyword
```
public void addKeyword(String keyword)
```
  - addKeywords
```
public void addKeywords(Collection<String> keywords)
```
  - getUpdateInfo
```
public UpdateInfo getUpdateInfo()
```
    Update information for this feed.
    
    Returns:
    
    a UpdateInfo instance, or null
  - setUpdateInfo
```
public void setUpdateInfo(UpdateInfo updateInfo)
```
  - setUpdatePeriod
```
public void setUpdatePeriod(String period)
```
  - setUpdateFrequency
```
public void setUpdateFrequency(Integer frequency)
```
  - setUpdateBase
```
public void setUpdateBase(ZonedDateTime base)
```
  - getRating
```
public Rating getRating()
```
    The rating for this item.
    
    Combines optional elements from iTunes RSS, Media RSS and Google Play spec.
    
    Returns:
    
    a Rating, not null
  - setRating
```
public void setRating(Rating rating)
```
  - getLocation
```
public String getLocation()
```
    The geographic location for this feed.
    
    Specified in RawVoice namespace specification.
    
    Returns:
    
    a String or null
  - setLocation
```
public void setLocation(String location)
```
  - getOtherValues
```
public Map<OtherValueKey,String> getOtherValues()
```
    A Map containing any value present in the podcast XML that is not mapped to any of the other values present here.
    
    See OtherValueKey for a full listing of possible values in this map.
    
    Returns:
    
    a Map, not null
  - addOtherValue
```
public void addOtherValue(OtherValueKey key,
                          String value)
```
  - getGeoPoint
```
public GeoPoint getGeoPoint()
```
    GeoPoint for this Item
    
    Returns:
    
    a GeoPoint or null
  - setGeoPoint
```
public void setGeoPoint(GeoPoint geoPoint)
```
  - setLatitude
```
public void setLatitude(BigDecimal latitude)
```
  - setLongitude
```
public void setLongitude(BigDecimal longitude)
```
  - getBlock
```
public boolean getBlock()
```
  - setBlock
```
public void setBlock(boolean block)
```
  - getSummary
```
public String getSummary()
```
  - setSummary
```
public void setSummary(String summary)
```
  - getType
```
public String getType()
```
  - setType
```
public void setType(String type)
```
  - getEmail
```
public String getEmail()
```
    String email for this Feed
    
    Specified in Google Play spec
    
    Returns:
    
    a String or null
  - setEmail
```
public void setEmail(String email)
```
  - getCredit
```
public Credit getCredit()
```
  - setCredit
```
public void setCredit(Credit credit)
```
  - isComplete
```
public boolean isComplete()
```
  - setComplete
```
public void setComplete(boolean complete)
```
  - getBrowserFriendly
```
public TypedString getBrowserFriendly()
```
  - setBrowserFriendly
```
public void setBrowserFriendly(TypedString browserFriendly)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Feed

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Feed

Method Detail

getId

setId

getTitle

setTitle

getLinks

addLink

getDescription

setDescription

getItems

addItem

getLanguage

setLanguage

getCopyright

setCopyright

getManagingEditor

setManagingEditor

getWebMaster

setWebMaster

getPubDate

setPubDate

getLastBuildDate

setLastBuildDate

getCategories

addCategory

getGenerator

setGenerator

getDocs

setDocs

getCloud

setCloud

getTtl

setTtl

getImages

addImage

getTextInput

setTextInput

getSkipHours

addSkipHour

getSkipDays

addSkipDay

getSubtitle

setSubtitle

getAuthors

addAuthor

getOwner

setOwner

getContributors

addContributor

getKeywords

addKeyword

addKeywords

getUpdateInfo

setUpdateInfo

setUpdatePeriod

setUpdateFrequency

setUpdateBase

getRating

setRating

getLocation

setLocation

getOtherValues

addOtherValue

getGeoPoint

setGeoPoint

setLatitude

setLongitude

getBlock

setBlock

getSummary

setSummary

getType

setType

getEmail