Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.jxbeans
Class AbstractDocumentSource  view AbstractDocumentSource download AbstractDocumentSource.java

java.lang.Object
  extended byorg.jxbeans.AbstractJXBean
      extended byorg.jxbeans.AbstractDocumentSource
All Implemented Interfaces:
DocumentSource, java.io.Serializable
Direct Known Subclasses:
AbstractTransformerJXBean

public abstract class AbstractDocumentSource
extends AbstractJXBean
implements DocumentSource

The AbstractDocumentSource class provides a convenient superclass for any class that implements the DocumentSource interface. Specifically, this class provides a generic implementation of the DocumentSource interface.

Since:
1.0
Version:
1.0

Field Summary
protected  java.util.List listeners
           
 
Fields inherited from class org.jxbeans.AbstractJXBean
 
Constructor Summary
AbstractDocumentSource()
           
 
Method Summary
 void addDocumentReadyListener(DocumentReadyListener aDocumentReadyListener)
          Adds the specified DocumentReadyListener to the list of DocumentReadyListeners that this bean will notify when it publishes a DocumentReadyEvent.
protected  void forwardDocument(org.jdom.Document aDocument)
          A method for subclasses to publish a document, using a DocumentReadyEvent, to the DocumentReadyListeners of this object.
protected  void forwardDocument(org.jdom.Document aDocument, java.util.List aListOfListeners)
          A method for subclasses to publish a document, using a DocumentReadyEvent, to a list of DocumentReadyListeners.
 DocumentReadyListener[] getDocumentReadyListeners()
           
protected  void logDocument(org.jdom.Document aDocument)
          A method for subclasses to log the contents of a document to the logging system.
 void removeDocumentReadyListener(DocumentReadyListener aDocumentReadyListener)
          Removes the specified DocumentReadyListener from the list of DocumentReadyListeners that this bean will notify when it publishes a DocumentReadyEvent.
 
Methods inherited from class org.jxbeans.AbstractJXBean
getName, logErrorAndRaiseException, logMethodEntry, logMethodEntry, logMethodExit, logMethodExit, setName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

listeners

protected java.util.List listeners
Constructor Detail

AbstractDocumentSource

public AbstractDocumentSource()
Method Detail

addDocumentReadyListener

public void addDocumentReadyListener(DocumentReadyListener aDocumentReadyListener)
                              throws java.util.TooManyListenersException
Description copied from interface: DocumentSource
Adds the specified DocumentReadyListener to the list of DocumentReadyListeners that this bean will notify when it publishes a DocumentReadyEvent.

Specified by:
addDocumentReadyListener in interface DocumentSource

removeDocumentReadyListener

public void removeDocumentReadyListener(DocumentReadyListener aDocumentReadyListener)
Description copied from interface: DocumentSource
Removes the specified DocumentReadyListener from the list of DocumentReadyListeners that this bean will notify when it publishes a DocumentReadyEvent. The specified DocumentReadyListener will no longer receive DocumentReadyEvents from this bean.

Specified by:
removeDocumentReadyListener in interface DocumentSource

getDocumentReadyListeners

public DocumentReadyListener[] getDocumentReadyListeners()

forwardDocument

protected void forwardDocument(org.jdom.Document aDocument)
                        throws JXBeanException
A method for subclasses to publish a document, using a DocumentReadyEvent, to the DocumentReadyListeners of this object.

Since:
1.0

forwardDocument

protected void forwardDocument(org.jdom.Document aDocument,
                               java.util.List aListOfListeners)
                        throws JXBeanException
A method for subclasses to publish a document, using a DocumentReadyEvent, to a list of DocumentReadyListeners.

Since:
1.0

logDocument

protected void logDocument(org.jdom.Document aDocument)
A method for subclasses to log the contents of a document to the logging system. The document will be logged to a log category that corresponds to the subclass' fully qualified class name, only if debugging logging is enamed for that category.

Since:
1.0