lib
Class Documentation

java.lang.Object
  extended by lib.Documentation

public class Documentation
extends java.lang.Object

The Documentation construct exists to hold version information that is held in a standard structure at the start of the file.

Version:
1.0
Author:
CobaltSoftware (abode.devteam@cobaltsoftware.net)

Field Summary
private  java.lang.String strAuthor
           
private  java.lang.String strMemo
           
private  java.lang.String strTitle
           
 
Constructor Summary
Documentation()
          Initialize a blank documentation construct
Documentation(java.lang.String title, java.lang.String authorInfo, java.lang.String memo)
          Initialize a documentation construct with all of the various options set.
 
Method Summary
 java.lang.String getAuthor()
          Get the author of the file
 java.lang.String getMemo()
          Get file memo
 java.lang.String getTitle()
          Get the title of the file
 void setAuthor(java.lang.String author)
          Set the author of the file
 void setMemo(java.lang.String memo)
          Set file memo
 void setTitle(java.lang.String title)
          Set the title of the file
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

strTitle

private java.lang.String strTitle

strAuthor

private java.lang.String strAuthor

strMemo

private java.lang.String strMemo
Constructor Detail

Documentation

public Documentation()
Initialize a blank documentation construct


Documentation

public Documentation(java.lang.String title,
                     java.lang.String authorInfo,
                     java.lang.String memo)
Initialize a documentation construct with all of the various options set.

Parameters:
title - Title of the file
authorInfo - Who wrote the file
memo - Some notes about the file
Method Detail

getTitle

public java.lang.String getTitle()
Get the title of the file

Returns:
Title of the file

setTitle

public void setTitle(java.lang.String title)
Set the title of the file

Parameters:
title - Title of the file

getAuthor

public java.lang.String getAuthor()
Get the author of the file

Returns:
Author of the file

setAuthor

public void setAuthor(java.lang.String author)
Set the author of the file

Parameters:
author - Author of the file

getMemo

public java.lang.String getMemo()
Get file memo

Returns:
Memo/notes for this file.

setMemo

public void setMemo(java.lang.String memo)
Set file memo

Parameters:
memo - New memo/notes for this file.