|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object lib.Documentation
public class Documentation
The Documentation construct exists to hold version information that is held in a standard structure at the start of the file.
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 |
---|
private java.lang.String strTitle
private java.lang.String strAuthor
private java.lang.String strMemo
Constructor Detail |
---|
public Documentation()
public Documentation(java.lang.String title, java.lang.String authorInfo, java.lang.String memo)
title
- Title of the fileauthorInfo
- Who wrote the filememo
- Some notes about the fileMethod Detail |
---|
public java.lang.String getTitle()
public void setTitle(java.lang.String title)
title
- Title of the filepublic java.lang.String getAuthor()
public void setAuthor(java.lang.String author)
author
- Author of the filepublic java.lang.String getMemo()
public void setMemo(java.lang.String memo)
memo
- New memo/notes for this file.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |