Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.rometools.feed.opml
Class Opml

java.lang.Object
  extended by com.sun.syndication.feed.WireFeed
      extended by org.rometools.feed.opml.Opml
All Implemented Interfaces:
com.sun.syndication.feed.module.Extendable, Serializable, Cloneable
public class Opml
extends com.sun.syndication.feed.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.

Author:
Robert "kebernet" Cooper
See Also:
Serialized Form

Constructor Summary
Opml()
          Creates a new instance of Opml
 
Method Summary
 Date getCreated()
          <dateCreated> is a date-time, indicating when the document was created.
 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.
 Date getModified()
          <dateModified> is a date-time, indicating when the document was last modified.
 List getOutlines()
          Root level Outline object that should appear in the <body>
 String getOwnerEmail()
          <ownerEmail> is a string, the email address of the owner of the document.
 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.
 String getOwnerName()
          <ownerName> is a string, the owner of the document.
 String getTitle()
          <title> is the title of the document.
 Integer getVerticalScrollState()
          <vertScrollState> is a number, saying which line of the outline is displayed on the top line of the window.
 Integer getWindowBottom()
          <windowBottom> is a number, the pixel location of the bottom edge of the window.
 Integer getWindowLeft()
          <windowLeft> is a number, the pixel location of the left edge of the window.
 Integer getWindowRight()
          <windowRight> is a number, the pixel location of the right edge of the window.
 Integer getWindowTop()
          <windowTop> is a number, the pixel location of the top edge of the window.
 void setCreated(Date created)
           is a date-time, indicating when the document was created.
 void setDocs(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(Date modified)
          <dateModified> is a date-time, indicating when the document was last modified.
 void setOutlines(List outlines)
          Root level Outline object that should appear in the <body>
 void setOwnerEmail(String ownerEmail)
          <ownerEmail> is a string, the email address of the owner of the document.
 void setOwnerId(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(String ownerName)
          <ownerName> is a string, the owner of the document.
 void setTitle(String title)
          <title> is the title of the document.
 void setVerticalScrollState(Integer verticalScrollState)
          <vertScrollState> is a number, saying which line of the outline is displayed on the top line of the window.
 void setWindowBottom(Integer windowBottom)
          <windowBottom> is a number, the pixel location of the bottom edge of the window.
 void setWindowLeft(Integer windowLeft)
          <windowLeft> is a number, the pixel location of the left edge of the window.
 void setWindowRight(Integer windowRight)
          <windowRight> is a number, the pixel location of the right edge of the window.
 void setWindowTop(Integer windowTop)
          <windowTop> is a number, the pixel location of the top edge of the window.
 
Methods inherited from class com.sun.syndication.feed.WireFeed
clone, equals, getEncoding, getFeedType, getForeignMarkup, getModule, getModules, hashCode, setEncoding, setFeedType, setForeignMarkup, setModules, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Opml

public Opml()
Creates a new instance of Opml

Method Detail

setCreated

public void setCreated(Date created)
is a date-time, indicating when the document was created.

Parameters:
created - date-time, indicating when the document was created.

getCreated

public 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(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 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(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 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(List 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 List 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(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 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(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 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(String ownerName)
<ownerName> is a string, the owner of the document.

Parameters:
ownerName - the owner of the document.

getOwnerName

public String getOwnerName()
<ownerName> is a string, the owner of the document.

Returns:
the owner of the document.

setTitle

public void setTitle(String title)
<title> is the title of the document.

Parameters:
title - title of the document.

getTitle

public String getTitle()
<title> is the title of the document.

Returns:
title of the document.

setVerticalScrollState

public void setVerticalScrollState(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 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(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 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(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 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(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 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(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 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.
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2013 ROME Project. All Rights Reserved.