Opml (rome-parent 2.1.0 API)

java.lang.Object
- com.rometools.rome.feed.WireFeed
- - com.rometools.opml.feed.opml.Opml

All Implemented Interfaces:

Extendable, java.io.Serializable, java.lang.Cloneable
```
public class Opml
extends WireFeed
```
This class represents the root of an OPML 1/2 feed and contains the elements that may appear in the <head> tag of the feed.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Opml()

Constructors
Constructor and Description
`Opml()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.Date`	`getCreated()` <dateCreated> is a date-time, indicating when the document was created.
`java.lang.String`	`getDocs()` (OPML 2) <docs> is the http address of documentation for the format used in the OPML file.
`int[]`	`getExpansionState()` <expansionState> is a comma-separated list of line numbers that are expanded.
`java.util.Date`	`getModified()` <dateModified> is a date-time, indicating when the document was last modified.
`java.util.List<Outline>`	`getOutlines()` Root level Outline object that should appear in the <body>
`java.lang.String`	`getOwnerEmail()` <ownerEmail> is a string, the email address of the owner of the document.
`java.lang.String`	`getOwnerId()` (OPML 2) <ownerId> is the http address of a web page that contains ~~an HTML~~ a form that allows a human reader to communicate with the author of the document via email or other means.
`java.lang.String`	`getOwnerName()` <ownerName> is a string, the owner of the document.
`java.lang.String`	`getTitle()` <title> is the title of the document.
`java.lang.Integer`	`getVerticalScrollState()` <vertScrollState> is a number, saying which line of the outline is displayed on the top line of the window.
`java.lang.Integer`	`getWindowBottom()` <windowBottom> is a number, the pixel location of the bottom edge of the window.
`java.lang.Integer`	`getWindowLeft()` <windowLeft> is a number, the pixel location of the left edge of the window.
`java.lang.Integer`	`getWindowRight()` <windowRight> is a number, the pixel location of the right edge of the window.
`java.lang.Integer`	`getWindowTop()` <windowTop> is a number, the pixel location of the top edge of the window.
`void`	`setCreated(java.util.Date created)` is a date-time, indicating when the document was created.
`void`	`setDocs(java.lang.String docs)` (OPML 2) <docs> is the http address of documentation for the format used in the OPML file.
`void`	`setExpansionState(int[] expansionState)` <expansionState>is a comma-separated list of line numbers that are expanded.
`void`	`setModified(java.util.Date modified)` <dateModified> is a date-time, indicating when the document was last modified.
`void`	`setOutlines(java.util.List<Outline> outlines)` Root level Outline object that should appear in the <body>
`void`	`setOwnerEmail(java.lang.String ownerEmail)` <ownerEmail> is a string, the email address of the owner of the document.
`void`	`setOwnerId(java.lang.String ownerId)` (OPML 2) <ownerId> is the http address of a web page that contains ~~an HTML~~ a form that allows a human reader to communicate with the author of the document via email or other means.
`void`	`setOwnerName(java.lang.String ownerName)` <ownerName> is a string, the owner of the document.
`void`	`setTitle(java.lang.String title)` <title> is the title of the document.
`void`	`setVerticalScrollState(java.lang.Integer verticalScrollState)` <vertScrollState> is a number, saying which line of the outline is displayed on the top line of the window.
`void`	`setWindowBottom(java.lang.Integer windowBottom)` <windowBottom> is a number, the pixel location of the bottom edge of the window.
`void`	`setWindowLeft(java.lang.Integer windowLeft)` <windowLeft> is a number, the pixel location of the left edge of the window.
`void`	`setWindowRight(java.lang.Integer windowRight)` <windowRight> is a number, the pixel location of the right edge of the window.
`void`	`setWindowTop(java.lang.Integer windowTop)` <windowTop> is a number, the pixel location of the top edge of the window.

Methods inherited from class com.rometools.rome.feed.WireFeed
clone, equals, getEncoding, getFeedType, getForeignMarkup, getModule, getModules, getStyleSheet, hashCode, setEncoding, setFeedType, setForeignMarkup, setModules, setStyleSheet, toString

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

- Constructor Detail
  - Opml
```
public Opml()
```
- Method Detail
  - setCreated
```
public void setCreated(java.util.Date created)
```
    is a date-time, indicating when the document was created.
    
    Parameters:
    
    created - date-time, indicating when the document was created.
  - getCreated
```
public java.util.Date getCreated()
```
    <dateCreated> is a date-time, indicating when the document was created.
    
    Returns:
    
    date-time, indicating when the document was created.
  - setDocs
```
public void setDocs(java.lang.String docs)
```
    (OPML 2) <docs> is the http address of documentation for the format used in the OPML file. It's probably a pointer to this page for people who might stumble across the file on a web server 25 years from now and wonder what it is.
    
    Parameters:
    
    docs - http address of documentation for the format used
  - getDocs
```
public java.lang.String getDocs()
```
    (OPML 2) <docs> is the http address of documentation for the format used in the OPML file. It's probably a pointer to this page for people who might stumble across the file on a web server 25 years from now and wonder what it is.
    
    Returns:
    
    http address of documentation for the format used
  - setExpansionState
```
public void setExpansionState(int[] expansionState)
```
    <expansionState>is a comma-separated list of line numbers that are expanded. The line numbers in the list tell you which headlines to expand. The order is important. For each element in the list, X, starting at the first summit, navigate flatdown X times and expand. Repeat for each element in the list.
    
    Parameters:
    
    expansionState - int array containing expanded elements.
  - getExpansionState
```
public int[] getExpansionState()
```
    <expansionState> is a comma-separated list of line numbers that are expanded. The line numbers in the list tell you which headlines to expand. The order is important. For each element in the list, X, starting at the first summit, navigate flatdown X times and expand. Repeat for each element in the list.
    
    Returns:
    
    int array containing expanded elements.
  - setModified
```
public void setModified(java.util.Date modified)
```
    <dateModified> is a date-time, indicating when the document was last modified.
    
    Parameters:
    
    modified - date-time, indicating when the document was last modified.
  - getModified
```
public java.util.Date getModified()
```
    <dateModified> is a date-time, indicating when the document was last modified.
    
    Returns:
    
    date-time, indicating when the document was last modified.
  - setOutlines
```
public void setOutlines(java.util.List<Outline> outlines)
```
    Root level Outline object that should appear in the <body>
    
    Parameters:
    
    outlines - Root level Outline object that should appear in the <body>
  - getOutlines
```
public java.util.List<Outline> getOutlines()
```
    Root level Outline object that should appear in the <body>
    
    Returns:
    
    Root level Outline object that should appear in the <body>
  - setOwnerEmail
```
public void setOwnerEmail(java.lang.String ownerEmail)
```
    <ownerEmail> is a string, the email address of the owner of the document.
    
    Parameters:
    
    ownerEmail - the email address of the owner of the document.
  - getOwnerEmail
```
public java.lang.String getOwnerEmail()
```
    <ownerEmail> is a string, the email address of the owner of the document.
    
    Returns:
    
    the email address of the owner of the document.
  - setOwnerId
```
public void setOwnerId(java.lang.String ownerId)
```
    (OPML 2) <ownerId> is the http address of a web page that contains ~~an HTML~~ a form that allows a human reader to communicate with the author of the document via email or other means.
    
    Parameters:
    
    ownerId - http address of a web page that contains ~~an HTML~~ a form that allows a human reader to communicate with the author of the document via email or other means.
  - getOwnerId
```
public java.lang.String getOwnerId()
```
    (OPML 2) <ownerId> is the http address of a web page that contains ~~an HTML~~ a form that allows a human reader to communicate with the author of the document via email or other means.
    
    Returns:
    
    http address of a web page that contains ~~an HTML~~ a form that allows a human reader to communicate with the author of the document via email or other means.
  - setOwnerName
```
public void setOwnerName(java.lang.String ownerName)
```
    <ownerName> is a string, the owner of the document.
    
    Parameters:
    
    ownerName - the owner of the document.
  - getOwnerName
```
public java.lang.String getOwnerName()
```
    <ownerName> is a string, the owner of the document.
    
    Returns:
    
    the owner of the document.
  - setTitle
```
public void setTitle(java.lang.String title)
```
    <title> is the title of the document.
    
    Parameters:
    
    title - title of the document.
  - getTitle
```
public java.lang.String getTitle()
```
    <title> is the title of the document.
    
    Returns:
    
    title of the document.
  - setVerticalScrollState
```
public void setVerticalScrollState(java.lang.Integer verticalScrollState)
```
    <vertScrollState> is a number, saying which line of the outline is displayed on the top line of the window. This number is calculated with the expansion state already applied.
    
    Parameters:
    
    verticalScrollState - which line of the outline is displayed on the top line of the window.
  - getVerticalScrollState
```
public java.lang.Integer getVerticalScrollState()
```
    <vertScrollState> is a number, saying which line of the outline is displayed on the top line of the window. This number is calculated with the expansion state already applied.
    
    Returns:
    
    which line of the outline is displayed on the top line of the window. This number is calculated with the expansion state already applied.
  - setWindowBottom
```
public void setWindowBottom(java.lang.Integer windowBottom)
```
    <windowBottom> is a number, the pixel location of the bottom edge of the window.
    
    Parameters:
    
    windowBottom - the pixel location of the bottom edge of the window.
  - getWindowBottom
```
public java.lang.Integer getWindowBottom()
```
    <windowBottom> is a number, the pixel location of the bottom edge of the window.
    
    Returns:
    
    the pixel location of the bottom edge of the window.
  - setWindowLeft
```
public void setWindowLeft(java.lang.Integer windowLeft)
```
    <windowLeft> is a number, the pixel location of the left edge of the window.
    
    Parameters:
    
    windowLeft - the pixel location of the left edge of the window.
  - getWindowLeft
```
public java.lang.Integer getWindowLeft()
```
    <windowLeft> is a number, the pixel location of the left edge of the window.
    
    Returns:
    
    the pixel location of the left edge of the window.
  - setWindowRight
```
public void setWindowRight(java.lang.Integer windowRight)
```
    <windowRight> is a number, the pixel location of the right edge of the window.
    
    Parameters:
    
    windowRight - the pixel location of the right edge of the window.
  - getWindowRight
```
public java.lang.Integer getWindowRight()
```
    <windowRight> is a number, the pixel location of the right edge of the window.
    
    Returns:
    
    the pixel location of the right edge of the window.
  - setWindowTop
```
public void setWindowTop(java.lang.Integer windowTop)
```
    <windowTop> is a number, the pixel location of the top edge of the window.
    
    Parameters:
    
    windowTop - the pixel location of the top edge of the window.
  - getWindowTop
```
public java.lang.Integer getWindowTop()
```
    <windowTop> is a number, the pixel location of the top edge of the window.
    
    Returns:
    
    the pixel location of the top edge of the window.

Class Opml

Constructor Summary

Method Summary

Methods inherited from class com.rometools.rome.feed.WireFeed

Methods inherited from class java.lang.Object

Constructor Detail

Opml

Method Detail

setCreated

getCreated

setDocs

getDocs

setExpansionState

getExpansionState

setModified

getModified

setOutlines

getOutlines

setOwnerEmail

getOwnerEmail

setOwnerId

getOwnerId

setOwnerName

getOwnerName

setTitle

getTitle

setVerticalScrollState

getVerticalScrollState

setWindowBottom

getWindowBottom

setWindowLeft

getWindowLeft

setWindowRight

getWindowRight

setWindowTop

getWindowTop