Item (Podcast Feed Parser 0.9.0 API)

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

```
public class Item
extends Object
```

Constructor Summary

Constructors
Constructor and Description

Item()

Constructors
Constructor and Description
`Item()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAuthor(Person author)`
`void`	`addCategory(Category category)`
`void`	`addChapter(Chapter chapter)`
`void`	`addCredit(Credit credit)`
`void`	`addHash(Hash hash)`
`void`	`addImage(Image image)`
`void`	`addKeyword(String keyword)`
`void`	`addKeywords(Collection<String> keywords)`
`void`	`addLink(Link link)`
`void`	`addMediaContent(MediaContent mediaContent)`
`void`	`addMediaContents(List<MediaContent> mediaContents)`
`void`	`addMetamark(Metamark metamark)`
`void`	`addOtherEnclosure(String key, Enclosure enclosure)`
`void`	`addOtherValue(OtherValueKey key, String value)`
`void`	`addScene(Scene scene)`
`void`	`addTranscript(Transcript transcript)`
`List<Person>`	`getAuthors()` Email address of the author of the item.
`boolean`	`getBlock()`
`Set<Category>`	`getCategories()` Includes the item in one or more categories.
`List<Chapter>`	`getChapters()` Not in RSS specification.
`Comments`	`getComments()` All information regarding comments for this `Item`
`TypedString`	`getContent()` list Not in RSS specification.
`Copyright`	`getCopyright()` The `rights` element is a Text construct that conveys information about rights held in and over an entry or feed.
`List<Credit>`	`getCredits()` Credits for this `Item`
`TypedString`	`getDescription()` The item synopsis.
`Duration`	`getDuration()` The duration of the media in the `Enclosure` of this `Item`.
`ZonedDateTime`	`getEdited()` Date when an item was edited.
`TypedString`	`getEmbed()` As specified in the RawVoice namespace
`Enclosure`	`getEnclosure()` list
`String`	`getEpisode()`
`String`	`getEpisodeType()` Whether this is a full episode, a trailer or a preview.
`GeoBox`	`getGeoBox()`
`GeoPoint`	`getGeoPoint()` `GeoPoint` for this `Item`
`String`	`getGuid()` guid stands for globally unique identifier.
`List<Hash>`	`getHashes()` Part of Media RSS namespace specification.
`List<Image>`	`getImages()`
`List<String>`	`getKeywords()` Not in RSS specification.
`String`	`getLanguage()` Language of this `Item`
`License`	`getLicense()` License information for this `Item`
`Set<Link>`	`getLinks()` The URL to the item (RSS spec).
`List<MediaContent>`	`getMediaContents()` A more expressive alternative to `getEnclosure()`.
`MediaPlayer`	`getMediaPlayer()`
`List<Metamark>`	`getMetamarks()`
`Integer`	`getOrder()`
`Map<String,Enclosure>`	`getOtherEnclosures()` A `Map` containing any alternative `Enclosure` in the podcast XML that is not the main enclosure.
`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.
`String`	`getProvider()`
`ZonedDateTime`	`getPubDate()` Date when the item was published.
`Rating`	`getRating()` The rating for this item.
`String`	`getRights()`
`List<Scene>`	`getScenes()`
`String`	`getSeason()`
`String`	`getSource()` The RSS channel that the item came from.
`String`	`getSubject()` Not in RSS specification.
`String`	`getSubtitle()` Subtitle of the item.
`String`	`getSummary()`
`TypedString`	`getTitle()` The title of the item.
`List<Transcript>`	`getTranscripts()`
`ZonedDateTime`	`getUpdated()` The `updated` element is a Date construct indicating the most recent instant in time when an entry or feed was modified in a way the publisher considers significant.
`ZonedDateTime`	`getValidity()` Date (often a range) of validity of a resource.
`Visibility`	`getVisibility()`
`boolean`	`isHd()` As specified in the RawVoice namespace
`void`	`setBlock(boolean block)`
`void`	`setComments(Comments comments)`
`void`	`setContent(TypedString content)`
`void`	`setCopyright(Copyright copyright)`
`void`	`setDescription(String description)`
`void`	`setDescription(TypedString description)`
`void`	`setDuration(Duration duration)`
`void`	`setDuration(String duration)` Parse and set duration.
`void`	`setEdited(ZonedDateTime edited)`
`void`	`setEmbed(TypedString embed)`
`void`	`setEnclosure(Enclosure enclosure)`
`void`	`setEpisode(String episode)`
`void`	`setEpisodeType(String episodeType)`
`void`	`setGeoBox(GeoBox geoBox)`
`void`	`setGeoPoint(GeoPoint geoPoint)`
`void`	`setGuid(String guid)`
`void`	`setHd(boolean hd)`
`void`	`setLanguage(String language)`
`void`	`setLatitude(BigDecimal latitude)`
`void`	`setLicense(License license)`
`void`	`setLongitude(BigDecimal longitude)`
`void`	`setMediaPlayer(MediaPlayer mediaPlayer)`
`void`	`setNumberOfComments(int number)`
`void`	`setOrder(Integer order)`
`void`	`setProvider(String provider)`
`void`	`setPubDate(ZonedDateTime pubDate)`
`void`	`setRating(Rating rating)`
`void`	`setRights(String rights)`
`void`	`setSeason(String season)`
`void`	`setSource(String source)`
`void`	`setSubject(String subject)`
`void`	`setSubtitle(String subtitle)`
`void`	`setSummary(String summary)`
`void`	`setTitle(String title)`
`void`	`setTitle(TypedString title)`
`void`	`setUpdated(ZonedDateTime updated)`
`void`	`setValidity(ZonedDateTime validity)`
`void`	`setVisibility(Visibility visibility)`
`String`	`toString()`

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

- Constructor Detail
  - Item
```
public Item()
```
- Method Detail
  - getTitle
```
public TypedString getTitle()
```
    The title of the item.
    
    Optional as per RSS specification.
    
    Returns:
    
    TypedString or null
  - setTitle
```
public void setTitle(String title)
```
  - setTitle
```
public void setTitle(TypedString title)
```
  - getSubtitle
```
public String getSubtitle()
```
    Subtitle of the item.
    
    Part of the iTunes specification.
    
    Returns:
    
    a String or null
  - setSubtitle
```
public void setSubtitle(String subtitle)
```
  - getLinks
```
public Set<Link> getLinks()
```
    The URL to the item (RSS spec).
    
    Required in RSS specification. Listed in Atom specification as element link.
    
    Returns:
    
    Set
  - addLink
```
public void addLink(Link link)
```
  - getDescription
```
public TypedString getDescription()
```
    The item synopsis.
    
    Part of the iTunes specification.
    
    Returns:
    
    a TypedString or null
  - setDescription
```
public void setDescription(String description)
```
  - setDescription
```
public void setDescription(TypedString description)
```
  - getAuthors
```
public List<Person> getAuthors()
```
    Email address of the author of the item.
    
    Returns:
    
    List of Person instances, never null
  - addAuthor
```
public void addAuthor(Person author)
```
  - getCategories
```
public Set<Category> getCategories()
```
    Includes the item in one or more categories.
    
    Returns:
    
    a Set of Category instances, never null, never containing null
  - addCategory
```
public void addCategory(Category category)
```
  - getCopyright
```
public Copyright getCopyright()
```
    The rights element is a Text construct that conveys information about rights held in and over an entry or feed.
    
    Listed as optional element rights in Atom specification.
    
    Returns:
    
    a Copyright or null
  - setCopyright
```
public void setCopyright(Copyright copyright)
```
  - getEnclosure
```
public Enclosure getEnclosure()
```
    list
    Describes a media object that is attached to the item.
    
    Optional for item elements in RSS specification.
    
    Returns:
    
    Enclosure or null
  - setEnclosure
```
public void setEnclosure(Enclosure enclosure)
```
  - getGuid
```
public String getGuid()
```
    guid stands for globally unique identifier. It's a string that uniquely identifies the item. When present, an aggregator may choose to use this string to determine if an item is new. <guid>http://some.server.com/weblogItem3207</guid> There are no rules for the syntax of a guid. Aggregators must view them as a string. It's up to the source of the feed to establish the uniqueness of the string. If the guid element has an attribute named "isPermaLink" with a value of true, the reader may assume that it is a permalink to the item, that is, a url that can be opened in a Web browser, that points to the full item described by the item element. An example: <guid isPermaLink="true">http://inessential.com/2002/09/01.php#a2</guid> isPermaLink is optional, its default value is true. If its value is false, the guid may not be assumed to be a url, or a url to anything in particular.
    
    Optional for item elements in RSS specification. Required item id as per Atom specification.
    
    Returns:
    
    a String or null
  - setGuid
```
public void setGuid(String guid)
```
  - getPubDate
```
public ZonedDateTime getPubDate()
```
    Date when the item was published.
    
    Optional for entry elements in Atom specification. Not part of RSS specification.
    
    Returns:
    
    a ZonedDateTime or null
  - setPubDate
```
public void setPubDate(ZonedDateTime pubDate)
```
  - getUpdated
```
public ZonedDateTime getUpdated()
```
    The updated element is a Date construct indicating the most recent instant in time when an entry or feed was modified in a way the publisher considers significant.
    
    Optional for item elements in RSS specification. Optional for entry elements in Atom specification.
    
    Returns:
    
    a ZonedDateTime or null
  - setUpdated
```
public void setUpdated(ZonedDateTime updated)
```
  - getValidity
```
public ZonedDateTime getValidity()
```
    Date (often a range) of validity of a resource.
    
    Specified in Dublin Core Terms RSS specification.
    
    Returns:
    
    a ZonedDateTime or null
  - setValidity
```
public void setValidity(ZonedDateTime validity)
```
  - getEdited
```
public ZonedDateTime getEdited()
```
    Date when an item was edited.
    
    Specified in Atom Publishing namespace specification.
    
    Returns:
    
    a ZonedDateTime or null
  - setEdited
```
public void setEdited(ZonedDateTime edited)
```
  - getSource
```
public String getSource()
```
    The RSS channel that the item came from.
    
    Optional for item elements in RSS specification.
    
    Returns:
    
    String or null
  - setSource
```
public void setSource(String source)
```
  - getRating
```
public Rating getRating()
```
    The rating for this item.
    
    Combines optional elements from iTunes RSS, Media RSS and Google Play spec.
    
    Returns:
    
    a Rating, never null
  - setRating
```
public void setRating(Rating rating)
```
  - getDuration
```
public Duration getDuration()
```
    The duration of the media in the Enclosure of this Item.
    
    Not in RSS specification. Part of iTunes RSS spec.
    
    Returns:
    
    Duration or null
  - setDuration
```
public void setDuration(Duration duration)
```
  - setDuration
```
public void setDuration(String duration)
```
    Parse and set duration.
    
    Parameters:
    
    duration - String formatted HH:MM:SS, H:MM:SS, MM:SS, or M:SS (H = hours, M = minutes, S = seconds). If an integer is provided (no colon present), the value is assumed to be in seconds. If one colon is present, the number to the left is assumed to be minutes, and the number to the right is assumed to be seconds. If more than two colons are present, the numbers furthest to the right are ignored.
  - getMediaContents
```
public List<MediaContent> getMediaContents()
```
    A more expressive alternative to getEnclosure(). Not always present.
    
    Part of the Media RSS specification. There are no limitations on the number of content elements per item, though it is recommended to have only one.
    
    Returns:
    
    a List, never null
    
    See Also:
    
    MediaContent
  - addMediaContent
```
public void addMediaContent(MediaContent mediaContent)
```
  - addMediaContents
```
public void addMediaContents(List<MediaContent> mediaContents)
```
  - getImages
```
public List<Image> getImages()
```
  - addImage
```
public void addImage(Image image)
```
  - getKeywords
```
public List<String> getKeywords()
```
    Not in RSS specification. Listed in iTunes RSS spec.
    
    Returns:
    
    a List, not null
  - addKeyword
```
public void addKeyword(String keyword)
```
  - addKeywords
```
public void addKeywords(Collection<String> keywords)
```
  - getContent
```
public TypedString getContent()
```
    list Not in RSS specification. Part of Content namespace.
    
    Returns:
    
    a TypedString or null
  - setContent
```
public void setContent(TypedString content)
```
  - getSubject
```
public String getSubject()
```
    Not in RSS specification. Part of DublinCore namespace.
    
    Returns:
    
    a String or null
  - setSubject
```
public void setSubject(String subject)
```
  - getComments
```
public Comments getComments()
```
    All information regarding comments for this Item
    
    Returns:
    
    a Comments instance, or null
  - setComments
```
public void setComments(Comments comments)
```
  - setNumberOfComments
```
public void setNumberOfComments(int number)
```
  - getChapters
```
public List<Chapter> getChapters()
```
    Not in RSS specification. Part of SimpleChapters namespace specifcation.
    
    Returns:
    
    a List, not null
  - addChapter
```
public void addChapter(Chapter chapter)
```
  - getHashes
```
public List<Hash> getHashes()
```
    Part of Media RSS namespace specification.
    
    Returns:
    
    a List, not null
  - addHash
```
public void addHash(Hash hash)
```
  - getLicense
```
public License getLicense()
```
    License information for this Item
    
    Returns:
    
    a License or null
  - setLicense
```
public void setLicense(License license)
```
  - getCredits
```
public List<Credit> getCredits()
```
    Credits for this Item
    
    Returns:
    
    a List, not null
  - addCredit
```
public void addCredit(Credit credit)
```
  - getLanguage
```
public String getLanguage()
```
    Language of this Item
    
    Part of the DublinCore namespace specification.
    
    Returns:
    
    a String or null
  - setLanguage
```
public void setLanguage(String language)
```
  - 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)
```
  - getOtherEnclosures
```
public Map<String,Enclosure> getOtherEnclosures()
```
    A Map containing any alternative Enclosure in the podcast XML that is not the main enclosure.
    setFull
    
    Returns:
    
    a Map, not null
  - addOtherEnclosure
```
public void addOtherEnclosure(String key,
                              Enclosure enclosure)
```
  - 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)
```
  - getGeoBox
```
public GeoBox getGeoBox()
```
  - setGeoBox
```
public void setGeoBox(GeoBox geoBox)
```
  - getOrder
```
public Integer getOrder()
```
  - setOrder
```
public void setOrder(Integer order)
```
  - getSummary
```
public String getSummary()
```
  - setSummary
```
public void setSummary(String summary)
```
  - getBlock
```
public boolean getBlock()
```
  - setBlock
```
public void setBlock(boolean block)
```
  - getEpisodeType
```
public String getEpisodeType()
```
    Whether this is a full episode, a trailer or a preview.
    
    Returns:
    
    String or null
  - setEpisodeType
```
public void setEpisodeType(String episodeType)
```
  - getEpisode
```
public String getEpisode()
```
  - setEpisode
```
public void setEpisode(String episode)
```
  - getSeason
```
public String getSeason()
```
  - setSeason
```
public void setSeason(String season)
```
  - getMediaPlayer
```
public MediaPlayer getMediaPlayer()
```
  - setMediaPlayer
```
public void setMediaPlayer(MediaPlayer mediaPlayer)
```
  - getScenes
```
public List<Scene> getScenes()
```
  - addScene
```
public void addScene(Scene scene)
```
  - getTranscripts
```
public List<Transcript> getTranscripts()
```
  - addTranscript
```
public void addTranscript(Transcript transcript)
```
  - isHd
```
public boolean isHd()
```
    As specified in the RawVoice namespace
    
    Returns:
    
    true if the video media specified in the child <enclosure> is in High Definition (ie. any video that is widescreen (16:9 aspect ratio) with a 720p, 720i, 1080p or 1080i resolution, or better)
  - setHd
```
public void setHd(boolean hd)
```
  - getEmbed
```
public TypedString getEmbed()
```
    As specified in the RawVoice namespace
    
    Returns:
    
    TypedString block of embed HTML markup that corresponds to the item’s media content, or null if not part of the feed
  - setEmbed
```
public void setEmbed(TypedString embed)
```
  - getMetamarks
```
public List<Metamark> getMetamarks()
```
  - addMetamark
```
public void addMetamark(Metamark metamark)
```
  - getProvider
```
public String getProvider()
```
  - setProvider
```
public void setProvider(String provider)
```
  - getVisibility
```
public Visibility getVisibility()
```
  - setVisibility
```
public void setVisibility(Visibility visibility)
```
  - getRights
```
public String getRights()
```
  - setRights
```
public void setRights(String rights)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Item

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Item

Method Detail

getTitle

setTitle

setTitle

getSubtitle

setSubtitle

getLinks

addLink

getDescription

setDescription

setDescription

getAuthors

addAuthor

getCategories

addCategory

getCopyright

setCopyright

getEnclosure

setEnclosure

getGuid

setGuid

getPubDate

setPubDate

getUpdated

setUpdated

getValidity

setValidity

getEdited

setEdited

getSource

setSource

getRating

setRating

getDuration

setDuration

setDuration

getMediaContents

addMediaContent

addMediaContents

getImages

addImage

getKeywords

addKeyword

addKeywords

getContent

setContent

getSubject

setSubject

getComments

setComments

setNumberOfComments

getChapters

addChapter

getHashes

addHash

getLicense

setLicense

getCredits

addCredit

getLanguage

setLanguage

getOtherValues

addOtherValue

getOtherEnclosures

addOtherEnclosure

getGeoPoint

setGeoPoint

setLatitude

setLongitude

getGeoBox

setGeoBox

getOrder

setOrder

getSummary