org.argouml.xml.todo
Class ToDoItemXMLHelper

java.lang.Object
  |
  +--org.argouml.xml.todo.ToDoItemXMLHelper

public class ToDoItemXMLHelper
extends java.lang.Object

Helper class to help save todo items properly in the .todo XML file. It provides a view of A ToDoItem particularly suited for saving in an XML file by encoding strings to preserve graphic characters and allow lines to be broken and still be able to regain the original contents.

See Also:
ToDoItem

Field Summary
protected  ToDoItem _item
           
 
Constructor Summary
ToDoItemXMLHelper(ToDoItem item)
          Creates a new ToDoItemXMLHelper for item.
 
Method Summary
 java.lang.String getDescription()
          Encodes the description of this ToDoItem in an XML safe way and returns the new String.
 java.lang.String getHeadline()
          Encodes the headline of this ToDoItem in an XML safe way and returns the new String.
 java.lang.String getMoreInfoURL()
          Encodes the moreInfoURL of this ToDoItem in an XML safe way and returns the new String.
 java.lang.String getPriority()
          Encodes the priority of this ToDoItem in an XML safe way and returns the new String.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_item

protected final ToDoItem _item
Constructor Detail

ToDoItemXMLHelper

public ToDoItemXMLHelper(ToDoItem item)
Creates a new ToDoItemXMLHelper for item.

Parameters:
item - A ToDoItem.
Method Detail

getHeadline

public java.lang.String getHeadline()
Encodes the headline of this ToDoItem in an XML safe way and returns the new String. The String can be regained by running the returned String through TodoParser::decode.

Returns:
The encoded headline.

getPriority

public java.lang.String getPriority()
Encodes the priority of this ToDoItem in an XML safe way and returns the new String. The String can be regained by running the returned String through TodoParser::decode and comparing to the STRING_prio_* values in TodoTokenTable.

Returns:
The encoded priority.

getMoreInfoURL

public java.lang.String getMoreInfoURL()
Encodes the moreInfoURL of this ToDoItem in an XML safe way and returns the new String. The String can be regained by running the returned String through TodoParser::decode.

Returns:
The encoded moreInfoURL.

getDescription

public java.lang.String getDescription()
Encodes the description of this ToDoItem in an XML safe way and returns the new String. The String can be regained by running the returned String through TodoParser::decode.

Returns:
The encoded description.


ArgoUML © 1996-2004 (20040306)ArgoUML HomepageArgoUML Developers' pageArgoUML Cookbook