be.ceau.opml.entity

Class Outline

java.lang.Object

be.ceau.opml.entity.Outline

All Implemented Interfaces:

Serializable

public class Outline
extends Object
implements Serializable

An <outline> is an XML element containing at least one required attribute, text, and zero or more additional attributes. An <outline> may contain zero or more <outline> sub-elements. No attribute may be repeated within the same <outline> element.

Instances are unmodifiable and threadsafe.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Outline(Map<String,String> attributes, List<Outline> subElements)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAttribute(String key) Convenience method.
Map<String,String>	getAttributes()
Outline	getSubElement(int index)
List<Outline>	getSubElements()
String	getText() Convenience method.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Outline

public Outline(Map<String,String> attributes,
               List<Outline> subElements)

Parameters:

attributes - a Map, can not be null, can not contain null or blank String as key

subElements - a List, can not be null

Throws:

IllegalArgumentException - if either argument null or if attributes contains a blank key

Method Detail

getAttributes

public Map<String,String> getAttributes()

Returns:

unmodifiable Map with all attributes of this Outline

getAttribute

public String getAttribute(String key)

Convenience method. Equivalent to:

  getAttributes().get(key);
 

Parameters:

key - a String, can not be null

Returns:

the value of that attribute, or null if not available

getText

public String getText()

Convenience method. Equivalent to:

  getAttributes().get("text");
 

As per the specification of OPML 2.0, the text attribute is required. However, it is not in the version 1.0 spec.

Returns:

the value of attribute text, or null if not available

getSubElements

public List<Outline> getSubElements()

getSubElement

public Outline getSubElement(int index)

Parameters:

index - index of the element to return

Returns:

Outline at the given index, or null if there is no element at that index

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object