Extension SDK 9.0.5

oracle.jdeveloper.audit
Class AbstractAuditAddin

java.lang.Object
  extended byoracle.jdeveloper.audit.AuditProvider
      extended byoracle.jdeveloper.audit.AbstractAuditAddin
All Implemented Interfaces:
Addin, Module

public abstract class AbstractAuditAddin
extends AuditProvider
implements Addin

A convenience abstract base class for writing an IDE addin whose purpose is to extend Audit. This class extends AuditProvider and fully implements the Addin interface. On JDeveloper initialization, it registers itself as an Audit provider. Therefore, to plug in an Analyzer, for example, a subclass need only override the getAnalyzers method inherited from AuditProvider to return the class of the analyzer.

To function properly in execution contexts in which no UI is created (e.g., ojaudit and ojmetrics), subclasses should not override initialize() but instead should override initializeAlways() and/or initializeUI(). initializeAlways is invoked in all contexts; initializeUI is only invoked in contexts in which the UI is created.

See Also:
AuditProvider, Addin

Nested Class Summary
 
Nested classes inherited from class oracle.jdeveloper.audit.AuditProvider
AuditProvider.PersistenceDelegateBinding
 
Constructor Summary
AbstractAuditAddin()
           
 
Method Summary
 boolean canShutdown()
          This method is invoked by the AddinManager before the IDE terminates. Addins should NOT use this method to release resources. They should only use this method to give users the opportunity to cancel the exit process if there is some process started by this addin still running. Implementations should return false to cancel the shutdown process. The AbstractAuditAddin implementation returns true.
 float ideVersion()
          This method is called to determine the ide version number for which this Addin was implemented.

The AbstractAuditAddin implementation returns the current IDE version.

 void initialize()
          Invoked by the AddinManager after the instance of the Addin is instantiated. When invoked, The Addin should register and menu items, and actions required for use during this classes lifecycle. Addin authors should take care to ensure that any extraneous initialization is not preformed on this method, and any startup code that can be delayed until a later time is delayed, as the Addin's are synchronously initialized during the startup of the IDE, and each Addin has the potential to negatively impact the startup time of the product. The AbstractAuditAddin implementation registers this class as an AuditProvider, invokes initializeAlways() and, if the UI is initializing, invokes initializeUI().
protected  void initializeAlways()
          Initializes subclass functionality that is always required, whether or not JDeveloper creates a user interface.
protected  void initializeUI()
          Initializes subclass functionality that applies only if JDeveloper creates a user interface.
 void shutdown()
          This method is invoked by the AddinManager when the IDE terminates. Any non java resources (file handles, database connections, etc) which are still being held by this Addin should be released by this method immediately. This method is not guaranteed to be called, but on normal terminations of the IDE, this method will be invoked. The AbstractAuditAddin implementation is empty.
 float version()
          This method is called to determine the Addin version number.

The AbstractAuditAddin implementation returns 1.0.

 
Methods inherited from class oracle.jdeveloper.audit.AuditProvider
getAnalyzers, getColumns, getModels, getPersistenceDelegates, getProfiles, getStyleSheets
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractAuditAddin

public AbstractAuditAddin()
Method Detail

initialize

public void initialize()
Invoked by the AddinManager after the instance of the Addin is instantiated. When invoked, The Addin should register and menu items, and actions required for use during this classes lifecycle. Addin authors should take care to ensure that any extraneous initialization is not preformed on this method, and any startup code that can be delayed until a later time is delayed, as the Addin's are synchronously initialized during the startup of the IDE, and each Addin has the potential to negatively impact the startup time of the product. The AbstractAuditAddin implementation registers this class as an AuditProvider, invokes initializeAlways() and, if the UI is initializing, invokes initializeUI().

Specified by:
initialize in interface Addin
See Also:
AddinManager

initializeAlways

protected void initializeAlways()
Initializes subclass functionality that is always required, whether or not JDeveloper creates a user interface. The AbstractAuditAddin implementation is empty.


initializeUI

protected void initializeUI()
Initializes subclass functionality that applies only if JDeveloper creates a user interface. The AbstractAuditAddin implementation is empty.


canShutdown

public boolean canShutdown()
This method is invoked by the AddinManager before the IDE terminates. Addins should NOT use this method to release resources. They should only use this method to give users the opportunity to cancel the exit process if there is some process started by this addin still running. Implementations should return false to cancel the shutdown process. The AbstractAuditAddin implementation returns true.

Specified by:
canShutdown in interface Addin

shutdown

public void shutdown()
This method is invoked by the AddinManager when the IDE terminates. Any non java resources (file handles, database connections, etc) which are still being held by this Addin should be released by this method immediately. This method is not guaranteed to be called, but on normal terminations of the IDE, this method will be invoked. The AbstractAuditAddin implementation is empty.

Specified by:
shutdown in interface Addin

ideVersion

public float ideVersion()
This method is called to determine the ide version number for which this Addin was implemented.

The AbstractAuditAddin implementation returns the current IDE version.

Specified by:
ideVersion in interface Addin
Returns:
the ide version number.

version

public float version()
This method is called to determine the Addin version number.

The AbstractAuditAddin implementation returns 1.0.

Specified by:
version in interface Addin
Returns:
the version number.

Extension SDK

 

Copyright © 1997, 2004, Oracle. All rights reserved.