Outline (rome-parent 2.1.0 API)

java.lang.Object
- com.rometools.opml.feed.opml.Outline

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class Outline
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable
```
This class represents an OPML outline element.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`Outline()`
`Outline(java.lang.String type, java.lang.String text)` Creates a new outline with the specified type and text values.
`Outline(java.lang.String title, java.net.URL xmlUrl, java.net.URL htmlUrl)` Creates an outline with the given title, xmlUrl and htmlUrl.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()`
`boolean`	`equals(java.lang.Object obj)`
`java.util.List<Attribute>`	`getAttributes()` List of attributes on this outline excluding the "common types" for the specification.
`java.lang.String`	`getAttributeValue(java.lang.String name)` Returns the value of an attribute on the outline or null.
`java.util.List<java.lang.String>`	`getCategories()` (OPML 2) A List of Strings indicating values in the category attribute.
`java.util.List<Outline>`	`getChildren()` A list of sub-outlines for this entry.
`java.util.Date`	`getCreated()` (OPML 2) created is the date-time that the outline node was created.
`java.lang.String`	`getHtmlUrl()` A convenience method to return the value of the htmlUrl attribute.
`java.util.List<Module>`	`getModules()`
`java.lang.String`	`getText()` The "text" attribute of the outline.
`java.lang.String`	`getTitle()` The "title" attribute of the outline.
`java.lang.String`	`getType()` The "type" attribute of the outline.
`java.lang.String`	`getUrl()` A convenience method to return the value of the url attribute.
`java.lang.String`	`getXmlUrl()` A convenience method to return the value of the xmlUrl attribute.
`int`	`hashCode()`
`boolean`	`isBreakpoint()` isBreakpoint is a string, either "true" or "false", indicating whether a breakpoint is set on this outline.
`boolean`	`isComment()` isComment is a string, either "true" or "false", indicating whether the outline is commented or not.
`void`	`setAttributes(java.util.List<Attribute> attributes)` List of attributes on this outline excluding the "common types" for the specification.
`void`	`setBreakpoint(boolean breakpoint)` isBreakpoint is a string, either "true" or "false", indicating whether a breakpoint is set on this outline.
`void`	`setCategories(java.util.List<java.lang.String> categories)` (OPML 2) A List of Strings indicating values in the category attribute.
`void`	`setChildren(java.util.List<Outline> children)` A list of sub-outlines for this entry.
`void`	`setComment(boolean comment)` isComment is a string, either "true" or "false", indicating whether the outline is commented or not.
`void`	`setCreated(java.util.Date created)` (OPML 2) created is the date-time that the outline node was created.
`void`	`setModules(java.util.List<Module> modules)`
`void`	`setText(java.lang.String text)` The "text" attribute of the outline.
`void`	`setTitle(java.lang.String title)` The "title" attribute of the outline.
`void`	`setType(java.lang.String type)` The "type" attribute of the outline.
`java.lang.String`	`toString()`

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

- Constructor Detail
  - Outline
```
public Outline()
```
  - Outline
```
public Outline(java.lang.String type,
               java.lang.String text)
```
    Creates a new outline with the specified type and text values.
    
    Parameters:
    
    type - type attribute value/
    
    text - text attribute value
  - Outline
```
public Outline(java.lang.String title,
               java.net.URL xmlUrl,
               java.net.URL htmlUrl)
```
    Creates an outline with the given title, xmlUrl and htmlUrl. This is traditionally used for aggregator feed lists and will get a type of "rss".
    
    Parameters:
    
    title - Title of the entry.
    
    xmlUrl - link to XML file.
    
    htmlUrl - link to html page.
- Method Detail
  - setAttributes
```
public void setAttributes(java.util.List<Attribute> attributes)
```
    List of attributes on this outline excluding the "common types" for the specification.
    
    Parameters:
    
    attributes - List of attributes on this outline.
  - getAttributes
```
public java.util.List<Attribute> getAttributes()
```
    List of attributes on this outline excluding the "common types" for the specification.
    
    Returns:
    
    List of attributes on this outline.
  - setBreakpoint
```
public void setBreakpoint(boolean breakpoint)
```
    isBreakpoint is a string, either "true" or "false", indicating whether a breakpoint is set on this outline. This attribute is mainly necessary for outlines used to edit scripts. If it's not present, the value is false.
    
    Parameters:
    
    breakpoint - whether a breakpoint is set on this outline.
  - isBreakpoint
```
public boolean isBreakpoint()
```
    isBreakpoint is a string, either "true" or "false", indicating whether a breakpoint is set on this outline. This attribute is mainly necessary for outlines used to edit scripts. If it's not present, the value is false.
    
    Returns:
    
    whether a breakpoint is set on this outline
  - setCategories
```
public void setCategories(java.util.List<java.lang.String> categories)
```
    (OPML 2) A List of Strings indicating values in the category attribute.
    
    Parameters:
    
    categories - (OPML 2) A List of Strings indicating values in the category attribute.
  - getCategories
```
public java.util.List<java.lang.String> getCategories()
```
    (OPML 2) A List of Strings indicating values in the category attribute.
    
    Returns:
    
    (OPML 2) A List of Strings indicating values in the category attribute.
  - setChildren
```
public void setChildren(java.util.List<Outline> children)
```
    A list of sub-outlines for this entry.
    
    Parameters:
    
    children - A list of sub-outlines for this entry.
  - getChildren
```
public java.util.List<Outline> getChildren()
```
    A list of sub-outlines for this entry.
    
    Returns:
    
    A list of sub-outlines for this entry.
  - setComment
```
public void setComment(boolean comment)
```
    isComment is a string, either "true" or "false", indicating whether the outline is commented or not. By convention if an outline is commented, all subordinate outlines are considered to also be commented. If it's not present, the value is false.
    
    Parameters:
    
    comment - whether the outline is commented
  - isComment
```
public boolean isComment()
```
    isComment is a string, either "true" or "false", indicating whether the outline is commented or not. By convention if an outline is commented, all subordinate outlines are considered to also be commented. If it's not present, the value is false.
    
    Returns:
    
    whether the outline is commented
  - setCreated
```
public void setCreated(java.util.Date created)
```
    (OPML 2) created is the date-time that the outline node was created.
    
    Parameters:
    
    created - date-time that the outline node was created.
  - getCreated
```
public java.util.Date getCreated()
```
    (OPML 2) created is the date-time that the outline node was created.
    
    Returns:
    
    date-time that the outline node was created.
  - getUrl
```
public java.lang.String getUrl()
```
    A convenience method to return the value of the url attribute.
    
    Returns:
    
    value of the htmlUrl attribute.
  - getHtmlUrl
```
public java.lang.String getHtmlUrl()
```
    A convenience method to return the value of the htmlUrl attribute.
    
    Returns:
    
    value of the htmlUrl attribute.
  - setModules
```
public void setModules(java.util.List<Module> modules)
```
  - getModules
```
public java.util.List<Module> getModules()
```
  - setText
```
public void setText(java.lang.String text)
```
    The "text" attribute of the outline.
    
    Parameters:
    
    text - The "text" attribute of the outline.
  - getText
```
public java.lang.String getText()
```
    The "text" attribute of the outline.
    
    Returns:
    
    The "text" attribute of the outline.
  - setTitle
```
public void setTitle(java.lang.String title)
```
    The "title" attribute of the outline.
    
    Parameters:
    
    title - The "title" attribute of the outline.
  - getTitle
```
public java.lang.String getTitle()
```
    The "title" attribute of the outline.
    
    Returns:
    
    The "title" attribute of the outline.
  - setType
```
public void setType(java.lang.String type)
```
    The "type" attribute of the outline.
    
    Parameters:
    
    type - The "type" attribute of the outline.
  - getType
```
public java.lang.String getType()
```
    The "type" attribute of the outline.
    
    Returns:
    
    The "type" attribute of the outline.
  - getXmlUrl
```
public java.lang.String getXmlUrl()
```
    A convenience method to return the value of the xmlUrl attribute.
    
    Returns:
    
    value of the xmlUrl attribute.
  - getAttributeValue
```
public java.lang.String getAttributeValue(java.lang.String name)
```
    Returns the value of an attribute on the outline or null.
    
    Parameters:
    
    name - name of the attribute.
  - clone
```
public java.lang.Object clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Outline

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Outline

Outline

Outline

Method Detail

setAttributes

getAttributes

setBreakpoint

isBreakpoint

setCategories

getCategories

setChildren

getChildren

setComment

isComment

setCreated

getCreated

getUrl

getHtmlUrl

setModules

getModules

setText

getText

setTitle

getTitle

setType

getType

getXmlUrl

getAttributeValue

clone

equals

hashCode

toString