alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

What this is

This file is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Other links

The source code

// $Id: ArgoModule.java,v 1.14 2004/08/08 08:22:24 mvw Exp $
// Copyright (c) 1996-2004 The Regents of the University of California. All
// Rights Reserved. Permission to use, copy, modify, and distribute this
// software and its documentation without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph appear in all copies.  This software program and
// documentation are copyrighted by The Regents of the University of
// California. The software program and documentation are supplied "AS
// IS", without any accompanying services from The Regents. The Regents
// does not warrant that the operation of the program will be
// uninterrupted or error-free. The end-user understands that the program
// was developed for research purposes and is advised not to rely
// exclusively on the program for any reason.  IN NO EVENT SHALL THE
// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

package org.argouml.application.api;

import java.util.Vector;

/**
 * Interface that defines the characteristics of an external
 *  module usable by Argo.
 *
 * @author  Will Howery
 * @author  Thierry Lach
 * @since 0.9.4
 */
public interface ArgoModule { 
    /**
     * External modules are supposed to be located at 
     * MODULEFILENAME.
     */
    public static final String MODULEFILENAME = ".argo.modules";
    
    /**
     * Or, alternatively, external modules may be located at 
     * MODULEFILENAME_ALTERNATE
     */
    public static final String MODULEFILENAME_ALTERNATE = "argo.modules";

    /** 
     * Method called when Argo is loading a module.
     * 
     * @return true if the module initialized properly.
     */
    public boolean initializeModule();
    
    /** 
     * Method called when Argo is unloading a module.
     * 
     * @return true if the module terminated properly.
     */
    public boolean shutdownModule();

    /** 
     * Called to enable or disable a module programmatically.
     * 
     * @param tf true to enable module, false to disable
     */
    public void setModuleEnabled(boolean tf);
    
    /** 
     * Allows determination if a module is enabled or disabled
     * 
     * @return true if the module is enabled, otherwise false
     */
    public boolean isModuleEnabled(); // determines if enabled-disabled

    /** 
     * Display name of the module.
     *
     * @return the module name
     */
    public String getModuleName();

    /** 
     * Textual description of the module.
     * 
     * @return the module description
     */
    public String getModuleDescription(); 

    /** 
     * The module version.
     * 
     * There is no specified format.
     * 
     * @return a string containing the module version
     */
    public String getModuleVersion(); 
    
    /** 
     * The module author.
     * 
     * @return a string containing the module author
     */
    public String getModuleAuthor(); 
    
    /** 
     * Calls all modules to let them add to a popup menu.
     * 
     * @param popUpActions Vector of actions
     * @param context which the actions are valid for
     *
     * @return Vector containing pop-up actions
     */
    public Vector getModulePopUpActions(Vector popUpActions, Object context);

    /** 
     * The module identifying key.
     * 
     * @return the string key the module uses to identify itself
     */
    public String getModuleKey();
}

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.