|
| |
|
| java.lang.Object
 vqwiki.AbstractNotify
vqwiki.file.FileNotify
| FileNotify | | public class FileNotify extends AbstractNotify (Code) | | Implementation of Notify which stores notification records in text files.
Notification files use the same filename as the associated topic and use
the extension ".ntf".
author:
Robert E Brewer
version:
0.1 |
| Constructor Summary | |
| public | FileNotify()
No-arg constructor for compatibility only, always use FileNotify(newTopicName) instead. | | public | FileNotify(String virtualWiki, String newTopicName)
Instantiates and reads in a Notify object. |
| Method Summary | |
| public void | addMember(String userName)
Adds a user to the list of members to be notified when the associated topic changes. | | protected String | fileBase()
Retrieves the home directory of the VQWiki installation. | | public static Collection | getAll(String virtualWiki)
| | public Collection | getMembers()
| | public boolean | isMember(String userName)
Checks whether the user is in the list of members to be notified when the associated topic changes. | | public synchronized void | removeMember(String userName)
Removes a user from the list of members to be notified when the associated topic changes. |
| membersToNotify | | protected Set membersToNotify(Code) | | |
| FileNotify | | public FileNotify()(Code) | | No-arg constructor for compatibility only, always use FileNotify(newTopicName) instead.
|
| FileNotify | | public FileNotify(String virtualWiki, String newTopicName) throws WikiException(Code) | | Instantiates and reads in a Notify object.
Parameters:
newTopicName - the topic name with which this notification is associated
exception:
vqwiki.WikiException - if the file could not be opened or read |
| addMember | | public void addMember(String userName) throws WikiException(Code) | | Adds a user to the list of members to be notified when the associated topic changes.
Parameters:
userName - the name of the user to add
exception:
vqwiki.WikiException - if the file could not be written |
| fileBase | | protected String fileBase()(Code) | | Retrieves the home directory of the VQWiki installation.
String the home directory |
| isMember | | public boolean isMember(String userName)(Code) | | Checks whether the user is in the list of members to be notified when the associated topic changes.
Parameters:
userName - the name of the user to check boolean True if the user is in the list. |
| removeMember | | public synchronized void removeMember(String userName) throws WikiException(Code) | | Removes a user from the list of members to be notified when the associated topic changes.
Parameters:
userName - the name of the user to remove
exception:
vqwiki.WikiException - if the file could not be written |
|
|
|