uk.co.agena.minerva.util.model
Class ModificationLog

java.lang.Object
  extended by uk.co.agena.minerva.util.model.ModificationLog
All Implemented Interfaces:
Writable

public class ModificationLog
extends java.lang.Object
implements Writable

Author:
Simon TODO To change the template for this generated type comment go to Window - Preferences - Java - Code Style - Code Templates

Nested Class Summary
 class ModificationLog.ModificationLogItem
          Inner class for the items which go into the modification log
 
Field Summary
static double version
           
 
Fields inherited from interface uk.co.agena.minerva.util.model.Writable
FIELD_SEPARATOR
 
Constructor Summary
ModificationLog()
          empty constructor
 
Method Summary
 ModificationLog.ModificationLogItem addLog(NameDescription description)
          Adds a modifiatcion item to the log, and returns it
 void clearLog()
          Removes all items from the log
 java.util.List getModificationItems()
          A list of the modifications for the log
 java.lang.String getTitle()
          The title of the modification log
 double getVersion()
          Returns the version of the class.
 int read(java.util.List strings, int currentLineNumber)
           
 void setModificationItems(java.util.List modificationItems)
          A list of the modifications for the log
 void setTitle(java.lang.String title)
          The title of the modification log
 void setVersion(double version)
          Sets the version number of the class.
 java.lang.String toString()
          returns the log as a string
 java.util.List write()
          Writes the object in question to a List of Strings.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

version

public static double version
Constructor Detail

ModificationLog

public ModificationLog()
empty constructor

Method Detail

addLog

public ModificationLog.ModificationLogItem addLog(NameDescription description)
Adds a modifiatcion item to the log, and returns it

Parameters:
description -
Returns:

clearLog

public void clearLog()
Removes all items from the log


toString

public java.lang.String toString()
returns the log as a string

Overrides:
toString in class java.lang.Object

getModificationItems

public java.util.List getModificationItems()
A list of the modifications for the log


setModificationItems

public void setModificationItems(java.util.List modificationItems)
A list of the modifications for the log


getTitle

public java.lang.String getTitle()
The title of the modification log


setTitle

public void setTitle(java.lang.String title)
The title of the modification log


write

public java.util.List write()
                     throws MinervaReadWriteException
Description copied from interface: Writable
Writes the object in question to a List of Strings.

Specified by:
write in interface Writable
Returns:
the List to which the Strings have been written
Throws:
MinervaReadWriteException - if there

read

public int read(java.util.List strings,
                int currentLineNumber)
         throws MinervaReadWriteException
Specified by:
read in interface Writable
Throws:
MinervaReadWriteException

getVersion

public double getVersion()
Description copied from interface: Writable
Returns the version of the class. Used to ensure backward compatibility.

Specified by:
getVersion in interface Writable
Returns:
the version number

setVersion

public void setVersion(double version)
Description copied from interface: Writable
Sets the version number of the class. Used to ensure backward compatibility.

Specified by:
setVersion in interface Writable
Parameters:
version - the version number


Copyright © 2006 Agena Ltd. All Rights Reserved.