org.intellimate.izou.system.file

Class FilePublisher

java.lang.Object

org.intellimate.izou.util.IzouModule

org.intellimate.izou.system.file.FilePublisher

All Implemented Interfaces:

Identifiable, MainProvider

public class FilePublisher
extends IzouModule

FilePublisher that notifies FileSubscriber objects. It is triggered when a file is reloaded. Particularly file subscribers are mapped to ReloadableFile objects. When a reloadable file is reloaded, all file subscribers belonging to it are notified. All file subscribers in general can also be notified.

Field Summary

Fields inherited from class org.intellimate.izou.util.IzouModule

log, main

Constructor Summary

Constructors

Constructor and Description
FilePublisher(Main main) Creates a new FilePublisher object.

Method Summary

Modifier and Type	Method and Description
IdentificationSet<FileSubscriber>	getFileSubscribersForReloadableFile(ReloadableFile reloadableFile) Get all subscribers for a reloadableFile
void	notifyAllFileSubcribers() Notifies all file subscribers.
void	notifyDefaultFileSubscribers() Notifies all default file subscribers, that is those that will all be notified no matter what.
void	notifyFileSubscribers(ReloadableFile reloadableFile) Notifies all file subscribers registered to reloadableFile
void	register(FileSubscriber fileSubscriber, Identification identification) Registers a FileSubscriber so that whenever any file is reloaded, the fileSubscriber is notified.
void	register(ReloadableFile reloadableFile, FileSubscriber fileSubscriber, Identification identification) Registers a FileSubscriber with a ReloadableFile.
void	unregister(FileSubscriber fileSubscriber) Unregisters all instances of fileSubscriber found.

Methods inherited from class org.intellimate.izou.util.IzouModule

debug, debug, error, error, fatal, fatal, getID, getMain

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.intellimate.izou.identification.Identifiable

isOwner

Constructor Detail

FilePublisher

public FilePublisher(Main main)

Creates a new FilePublisher object. There should only be one in Izou

Parameters:

main - an Instance of main, used to get all the other classes

Method Detail

register

public void register(ReloadableFile reloadableFile,
                     FileSubscriber fileSubscriber,
                     Identification identification)
              throws IllegalIDException

Registers a FileSubscriber with a ReloadableFile. So when the reloadableFile is reloaded, the fileSubscriber will be notified. Multiple file subscribers can be registered with the same reloadable file.

Parameters:

reloadableFile - the reloadable file that should be observed

fileSubscriber - the fileSubscriber that should be notified when the reloadable file is reloaded

identification - the Identification of the FileSubscriber

Throws:

IllegalIDException - not yet implemented

register

public void register(FileSubscriber fileSubscriber,
                     Identification identification)
              throws IllegalIDException

Registers a FileSubscriber so that whenever any file is reloaded, the fileSubscriber is notified.

Parameters:

fileSubscriber - the fileSubscriber that should be notified when the reloadable file is reloaded

identification - the Identification of the FileSubscriber

Throws:

IllegalIDException - not yet implemented

unregister

public void unregister(FileSubscriber fileSubscriber)

Unregisters all instances of fileSubscriber found.

Parameters:

fileSubscriber - the fileSubscriber to unregister

notifyFileSubscribers

public void notifyFileSubscribers(ReloadableFile reloadableFile)

Notifies all file subscribers registered to reloadableFile

Parameters:

reloadableFile - the ReloadableFile object for which to notify all pertaining file subscribers

notifyAllFileSubcribers

public void notifyAllFileSubcribers()

Notifies all file subscribers.

notifyDefaultFileSubscribers

public void notifyDefaultFileSubscribers()

Notifies all default file subscribers, that is those that will all be notified no matter what.

getFileSubscribersForReloadableFile

public IdentificationSet<FileSubscriber> getFileSubscribersForReloadableFile(ReloadableFile reloadableFile)

Get all subscribers for a reloadableFile

Parameters:

reloadableFile - the reloadableFile for which to get all subscribers

Returns:

all subscribers for a reloadableFile