home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Programming Languages Suite
/
ProgLangD.iso
/
VCAFE.3.0A
/
Main.bin
/
Plugin.java
< prev
next >
Wrap
Text File
|
1998-10-25
|
2KB
|
63 lines
/*
* Copyright 1998 Symantec Corporation, All Rights Reserved.
*/
package com.symantec.itools.vcafe.openapi.pluginapi;
import java.io.InputStream;
import java.io.OutputStream;
/**
* The API used to integrate a software component/feature into the Visual Cafe
*
* @author Symantec Internet Tools Division
* @version 1.0
* @since VCafe 3.0
*/
public interface Plugin
{
/**
* This method is called by the Visual Cafe framework, after it successfully loads
* a plugin class and create an instance of it. Access to Visual Cafe open API is
* granted during this initialization.
*/
void init();
/**
* Before Visual Cafe exits, this method is called for every initialized plugin.
* The plugin should not perform any action after this method is called. In particular,
* threads created by the plugin must be destroyed.
*/
void destroy();
/**
* Plugin info. ** NOT YET IMPLEMENTED **
* A place holder to obtain name, version and other info of a plugin.
*/
void getPluginInfo();
/**
* Plugin persistence. This method is called by the Visual Cafe framework when
* saving workspace information to the disk. This could happen when a project
* is closed or Visual Cafe is shutdown, or a workspace is switched.
* A plug in might want to save any state information it might have
* This information can be read back in the restore method when the framework loads
* the workspace.
*
* @param os the output stream to which data will be written
* @param b true for local workspace and false for global workspace
*/
void save(OutputStream os, boolean local);
/**
* Plugin persistence. This method is called by the Visual Cafe framework when
* restoring workspace information from the disk. This could happen when a project
* is opened or Visual Cafe is started, or a workspace is switched.
* A plug in might want to read any state information it might have saved earlier
*
* @param is the input stream from which to read the data
* @param b true for local workspace and false for global workspace
*/
void restore(InputStream is, boolean local);
}