BasicOEmbed (nmote-oembed 0.9 API)

java.lang.Object
- com.nmote.oembed.BasicOEmbed

All Implemented Interfaces:

Favicon, OEmbed, Pingback, Webmention, Serializable

Direct Known Subclasses:

AmChartsEmbed, AnimotoEmbed, CollegeHumorEmbed, CoubEmbed, DeviantArtEmbed, DotSubEmbed, EmbedlyEmbed, FunnyOrDieEmbed, GettyImagesEmbed, HuluEmbed, InstagramEmbed, MixCloudEmbed, MobyPictureEmbed, NfbCanadaEmbed, NoembedEmbed, SapoVideosEmbed, SlideShareEmbed, ViddlerEmbed, VideoJugEmbed, VimeoEmbed, WebPageAndLicenseEmbed
```
public class BasicOEmbed
extends Object
implements OEmbed, Serializable, Favicon, Pingback, Webmention
```
Standard OEmbed implementation.

Author:

vnesek

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface com.nmote.oembed.OEmbed
  OEmbed.Type

Constructor Summary

Constructors
Constructor and Description

BasicOEmbed()

Constructors
Constructor and Description
`BasicOEmbed()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAuthorName()` The name of the author/owner of the resource.
`String`	`getAuthorUrl()` A URL for the author/owner of the resource.
`Long`	`getCacheAge()` The suggested cache lifetime for this resource, in seconds.
`String`	`getDescription()` Description
`String`	`getFaviconUrl()` Favicon URL
`Integer`	`getHeight()` The height in pixels of the image specified in the url parameter.
`String`	`getHtml()` The HTML required to embed a video player.
`String`	`getPingbackUrl()` Pingback URL.
`String`	`getProviderName()` The name of the resource provider.
`String`	`getProviderUrl()` The url of the resource provider.
`Integer`	`getThumbnailHeight()` The height of the optional thumbnail.
`String`	`getThumbnailUrl()` A URL to a thumbnail image representing the resource.
`Integer`	`getThumbnailWidth()` The width of the optional thumbnail.
`String`	`getTitle()` A text title describing the resource.
`String`	`getType()` The resource type.
`String`	`getUrl()` The source URL of the image.
`String`	`getVersion()` The oEmbed version number.
`String`	`getWebmentionUrl()` The webmention URL.
`Integer`	`getWidth()` The width in pixels of the image specified in the url parameter.
`boolean`	`hasDescription()` Returns true if oEmbed has description.
`boolean`	`hasHtml()` Returns true if oEmbed has html.
`boolean`	`hasThumbnail()` Returns true if oEmbed has thumbnail.
`boolean`	`hasTitle()` Returns true if oEmbed has title.
`void`	`setAuthorName(String authorName)` Set author name
`void`	`setAuthorUrl(String authorUrl)` Set author URL
`void`	`setCacheAge(Long cacheAge)` Set cache age.
`void`	`setDescription(String description)` Set description.
`void`	`setFaviconUrl(String faviconUrl)` Set favicon URL.
`void`	`setHeight(Integer height)` Set height in pixels.
`void`	`setHtml(String html)` Set HTML content.
`void`	`setPingbackUrl(String pingbackUrl)` Set pingback URL.
`void`	`setProviderName(String providerName)` Set oEmbed provider name.
`void`	`setProviderUrl(String providerUrl)` Set oEmbed provider URL
`void`	`setThumbnailHeight(Integer thumbnailHeight)` Set thumbnail height in pixels.
`void`	`setThumbnailUrl(String thumbnailUrl)` Set thumbnail URL.
`void`	`setThumbnailWidth(Integer thumbnailWidth)` Set thumbnail width in pixels
`void`	`setTitle(String title)` Set title
`void`	`setType(String type)` Set oEmbed type.
`void`	`setUrl(String url)` Set content URL.
`void`	`setVersion(String version)` Set oEmbed version.
`void`	`setWebmentionUrl(String webmentionUrl)` Set webmention URL.
`void`	`setWidth(Integer width)` Set width in pixels.
`String`	`toString()`

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

- Constructor Detail
  - BasicOEmbed
```
public BasicOEmbed()
```
- Method Detail
  - getAuthorName
```
public String getAuthorName()
```
    Description copied from interface: OEmbed
    
    The name of the author/owner of the resource.
    
    Specified by:
    
    getAuthorName in interface OEmbed
    
    Returns:
    
    author name
  - getAuthorUrl
```
public String getAuthorUrl()
```
    Description copied from interface: OEmbed
    
    A URL for the author/owner of the resource.
    
    Specified by:
    
    getAuthorUrl in interface OEmbed
    
    Returns:
    
    author url
  - getCacheAge
```
public Long getCacheAge()
```
    Description copied from interface: OEmbed
    
    The suggested cache lifetime for this resource, in seconds. Consumers may choose to ignore this value.
    
    Specified by:
    
    getCacheAge in interface OEmbed
    
    Returns:
    
    cache age in seconds
  - getDescription
```
public String getDescription()
```
    Description copied from interface: OEmbed
    
    Description
    
    Specified by:
    
    getDescription in interface OEmbed
    
    Returns:
    
    description
  - getFaviconUrl
```
public String getFaviconUrl()
```
    Description copied from interface: Favicon
    
    Favicon URL
    
    Specified by:
    
    getFaviconUrl in interface Favicon
    
    Returns:
    
    favicon URL
  - getHeight
```
public Integer getHeight()
```
    Description copied from interface: OEmbed
    
    The height in pixels of the image specified in the url parameter.
    
    Specified by:
    
    getHeight in interface OEmbed
    
    Returns:
    
    height in px
  - getHtml
```
public String getHtml()
```
    Description copied from interface: OEmbed
    
    The HTML required to embed a video player. The HTML should have no padding or margins. Consumers may wish to load the HTML in an off-domain iframe to avoid XSS vulnerabilities.
    
    Specified by:
    
    getHtml in interface OEmbed
    
    Returns:
    
    HTML content
  - getPingbackUrl
```
public String getPingbackUrl()
```
    Description copied from interface: Pingback
    
    Pingback URL.
    
    Specified by:
    
    getPingbackUrl in interface Pingback
    
    Returns:
    
    url
  - getProviderName
```
public String getProviderName()
```
    Description copied from interface: OEmbed
    
    The name of the resource provider.
    
    Specified by:
    
    getProviderName in interface OEmbed
    
    Returns:
    
    provider name
  - getProviderUrl
```
public String getProviderUrl()
```
    Description copied from interface: OEmbed
    
    The url of the resource provider.
    
    Specified by:
    
    getProviderUrl in interface OEmbed
    
    Returns:
    
    provider url
  - getThumbnailHeight
```
public Integer getThumbnailHeight()
```
    Description copied from interface: OEmbed
    
    The height of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_width must also be present.
    
    Specified by:
    
    getThumbnailHeight in interface OEmbed
    
    Returns:
    
    height in px
  - getThumbnailUrl
```
public String getThumbnailUrl()
```
    Description copied from interface: OEmbed
    
    A URL to a thumbnail image representing the resource. The thumbnail must respect any maxwidth and maxheight parameters. If this parameter is present, thumbnail_width and thumbnail_height must also be present.
    
    Specified by:
    
    getThumbnailUrl in interface OEmbed
    
    Returns:
    
    url
  - getThumbnailWidth
```
public Integer getThumbnailWidth()
```
    Description copied from interface: OEmbed
    
    The width of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_height must also be present.
    
    Specified by:
    
    getThumbnailWidth in interface OEmbed
    
    Returns:
    
    width in px
  - getTitle
```
public String getTitle()
```
    Description copied from interface: OEmbed
    
    A text title describing the resource.
    
    Specified by:
    
    getTitle in interface OEmbed
    
    Returns:
    
    title
  - getType
```
public String getType()
```
    Description copied from interface: OEmbed
    
    The resource type. Valid values, along with value-specific parameters are described below.
    
    Specified by:
    
    getType in interface OEmbed
    
    Returns:
    
    type
  - getUrl
```
public String getUrl()
```
    Description copied from interface: OEmbed
    
    The source URL of the image. Consumers should be able to insert this URL into an <img> element. Only HTTP and HTTPS URLs are valid.
    
    Specified by:
    
    getUrl in interface OEmbed
    
    Returns:
    
    url
  - getVersion
```
public String getVersion()
```
    Description copied from interface: OEmbed
    
    The oEmbed version number. This must be 1.0.
    
    Specified by:
    
    getVersion in interface OEmbed
    
    Returns:
    
    version
  - getWebmentionUrl
```
public String getWebmentionUrl()
```
    Description copied from interface: Webmention
    
    The webmention URL.
    
    Specified by:
    
    getWebmentionUrl in interface Webmention
    
    Returns:
    
    webmention url
  - getWidth
```
public Integer getWidth()
```
    Description copied from interface: OEmbed
    
    The width in pixels of the image specified in the url parameter.
    
    Specified by:
    
    getWidth in interface OEmbed
    
    Returns:
    
    width in px
  - hasDescription
```
public boolean hasDescription()
```
    Description copied from interface: OEmbed
    
    Returns true if oEmbed has description.
    
    Specified by:
    
    hasDescription in interface OEmbed
    
    Returns:
    
    true if oEmbed has description
  - hasHtml
```
public boolean hasHtml()
```
    Description copied from interface: OEmbed
    
    Returns true if oEmbed has html.
    
    Specified by:
    
    hasHtml in interface OEmbed
    
    Returns:
    
    true if oEmbed has html
  - hasThumbnail
```
public boolean hasThumbnail()
```
    Description copied from interface: OEmbed
    
    Returns true if oEmbed has thumbnail.
    
    Specified by:
    
    hasThumbnail in interface OEmbed
    
    Returns:
    
    true if oEmbed has thumbnail
  - hasTitle
```
public boolean hasTitle()
```
    Description copied from interface: OEmbed
    
    Returns true if oEmbed has title.
    
    Specified by:
    
    hasTitle in interface OEmbed
    
    Returns:
    
    true if oEmbed has title
  - setAuthorName
```
public void setAuthorName(String authorName)
```
    Set author name
    
    Parameters:
    
    authorName - author name
  - setAuthorUrl
```
public void setAuthorUrl(String authorUrl)
```
    Set author URL
    
    Parameters:
    
    authorUrl - author URL
  - setCacheAge
```
public void setCacheAge(Long cacheAge)
```
    Set cache age.
    
    Parameters:
    
    cacheAge - cache age in seconds
  - setDescription
```
public void setDescription(String description)
```
    Set description.
    
    Parameters:
    
    description - description
  - setFaviconUrl
```
public void setFaviconUrl(String faviconUrl)
```
    Set favicon URL.
    
    Parameters:
    
    faviconUrl - url
  - setHeight
```
public void setHeight(Integer height)
```
    Set height in pixels.
    
    Parameters:
    
    height - height in px
  - setHtml
```
public void setHtml(String html)
```
    Set HTML content.
    
    Parameters:
    
    html - HTML content
  - setPingbackUrl
```
public void setPingbackUrl(String pingbackUrl)
```
    Set pingback URL.
    
    Parameters:
    
    pingbackUrl - url
  - setProviderName
```
public void setProviderName(String providerName)
```
    Set oEmbed provider name.
    
    Parameters:
    
    providerName - provider name
  - setProviderUrl
```
public void setProviderUrl(String providerUrl)
```
    Set oEmbed provider URL
    
    Parameters:
    
    providerUrl - url
  - setThumbnailHeight
```
public void setThumbnailHeight(Integer thumbnailHeight)
```
    Set thumbnail height in pixels.
    
    Parameters:
    
    thumbnailHeight - height in px
  - setThumbnailUrl
```
public void setThumbnailUrl(String thumbnailUrl)
```
    Set thumbnail URL.
    
    Parameters:
    
    thumbnailUrl - url
  - setThumbnailWidth
```
public void setThumbnailWidth(Integer thumbnailWidth)
```
    Set thumbnail width in pixels
    
    Parameters:
    
    thumbnailWidth - width in px.
  - setTitle
```
public void setTitle(String title)
```
    Set title
    
    Parameters:
    
    title - title
  - setType
```
public void setType(String type)
```
    Set oEmbed type.
    
    Parameters:
    
    type - type
  - setUrl
```
public void setUrl(String url)
```
    Set content URL.
    
    Parameters:
    
    url - url
  - setVersion
```
public void setVersion(String version)
```
    Set oEmbed version.
    
    Parameters:
    
    version - oEmbed version
  - setWebmentionUrl
```
public void setWebmentionUrl(String webmentionUrl)
```
    Set webmention URL.
    
    Parameters:
    
    webmentionUrl - callback url
  - setWidth
```
public void setWidth(Integer width)
```
    Set width in pixels.
    
    Parameters:
    
    width - width in px.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Object.toString()

Class BasicOEmbed

Nested Class Summary

Nested classes/interfaces inherited from interface com.nmote.oembed.OEmbed

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BasicOEmbed

Method Detail

getAuthorName

getAuthorUrl

getCacheAge

getDescription

getFaviconUrl

getHeight

getHtml

getPingbackUrl

getProviderName

getProviderUrl

getThumbnailHeight

getThumbnailUrl

getThumbnailWidth

getTitle

getType

getUrl

getVersion

getWebmentionUrl

getWidth

hasDescription

hasHtml

hasThumbnail

hasTitle

setAuthorName

setAuthorUrl

setCacheAge

setDescription

setFaviconUrl

setHeight

setHtml

setPingbackUrl

setProviderName

setProviderUrl

setThumbnailHeight

setThumbnailUrl

setThumbnailWidth

setTitle

setType

setUrl

setVersion

setWebmentionUrl

setWidth

toString