Head (OPML Parser 2.0.0 API)

java.lang.Object
- be.ceau.opml.entity.Head

All Implemented Interfaces:

Serializable
```
public class Head
extends Object
implements Serializable
```
Metadata of the OPML feed. A <head> contains zero or more optional elements.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`Head(String title, String dateCreated, String dateModified, String ownerName, String ownerEmail, String ownerId, String docs, List<Integer> expansionState, Integer vertScrollState, Integer windowTop, Integer windowLeft, Integer windowBottom, Integer windowRight)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getDateCreated()` A date-time, indicating when the document was created (RFC 822 date)
`String`	`getDateModified()` A date-time, indicating when the document was last modified (RFC 822 date)
`String`	`getDocs()` 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.
`List<Integer>`	`getExpansionState()` A comma-separated list of line numbers that are expanded.
`String`	`getExpansionStateString()`
`String`	`getOwnerEmail()` The email address of the owner of the document
`String`	`getOwnerId()` The http address of a web page that contains information that allows a human reader to communicate with the author of the document via email or other means.
`String`	`getOwnerName()` The owner of the document
`String`	`getTitle()` The title of the document
`Integer`	`getVertScrollState()` Line of the outline is displayed on the top line of the window.
`Integer`	`getWindowBottom()` The pixel location of the bottom edge of the window
`Integer`	`getWindowLeft()` The pixel location of the left edge of the window
`Integer`	`getWindowRight()` The pixel location of the right edge of the window
`Integer`	`getWindowTop()` The pixel location of the top edge of the window
`int`	`hashCode()`
`String`	`toString()`

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

- Constructor Detail
  - Head
```
public Head(String title,
            String dateCreated,
            String dateModified,
            String ownerName,
            String ownerEmail,
            String ownerId,
            String docs,
            List<Integer> expansionState,
            Integer vertScrollState,
            Integer windowTop,
            Integer windowLeft,
            Integer windowBottom,
            Integer windowRight)
```
- Method Detail
  - getTitle
```
public String getTitle()
```
    The title of the document
    
    Returns:
    
    String or null if not set
  - getDateCreated
```
public String getDateCreated()
```
    A date-time, indicating when the document was created (RFC 822 date)
    
    Returns:
    
    String or null if not set
  - getDateModified
```
public String getDateModified()
```
    A date-time, indicating when the document was last modified (RFC 822 date)
    
    Returns:
    
    String or null if not set
  - getOwnerName
```
public String getOwnerName()
```
    The owner of the document
    
    Returns:
    
    String or null if not set
  - getOwnerEmail
```
public String getOwnerEmail()
```
    The email address of the owner of the document
    
    Returns:
    
    String or null if not set
  - getOwnerId
```
public String getOwnerId()
```
    The http address of a web page that contains information that allows a human reader to communicate with the author of the document via email or other means. It also may be used to identify the author. No two authors have the same ownerId.
    
    Returns:
    
    String or null if not set
  - getDocs
```
public String getDocs()
```
    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:
    
    String or null if not set
  - getExpansionState
```
public List<Integer> getExpansionState()
```
    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:
    
    mutable List, never null
  - getExpansionStateString
```
public String getExpansionStateString()
```
    Returns:
    
    serialized form of expansionState element
    
    See Also:
    
    getExpansionState()
  - getVertScrollState
```
public Integer getVertScrollState()
```
    Line of the outline is displayed on the top line of the window. This number is calculated with the expansion state already applied.
    
    Returns:
    
    Integer or null if not set
  - getWindowTop
```
public Integer getWindowTop()
```
    The pixel location of the top edge of the window
    
    Returns:
    
    Integer or null if not set
  - getWindowLeft
```
public Integer getWindowLeft()
```
    The pixel location of the left edge of the window
    
    Returns:
    
    Integer or null if not set
  - getWindowBottom
```
public Integer getWindowBottom()
```
    The pixel location of the bottom edge of the window
    
    Returns:
    
    Integer or null if not set
  - getWindowRight
```
public Integer getWindowRight()
```
    The pixel location of the right edge of the window
    
    Returns:
    
    Integer or null if not set
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class Head

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Head

Method Detail

getTitle

getDateCreated

getDateModified

getOwnerName

getOwnerEmail

getOwnerId

getDocs

getExpansionState

getExpansionStateString

getVertScrollState

getWindowTop

getWindowLeft

getWindowBottom

getWindowRight

toString

hashCode

equals