Changeset 7407


Ignore:
Timestamp:
12/13/10 12:46:10 (9 years ago)
Author:
aivar
Message:

More documentation.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • branches/maven/projects/deep-zoom-plugin/src/main/java/loci/multiinstanceplugin/IPlugin.java

    r7367 r7407  
     1// 
     2// IPlugin.java 
     3// 
     4 
    15/* 
    2  * To change this template, choose Tools | Templates 
    3  * and open the template in the editor. 
    4  */ 
     6Multiple instance chainable plugin framework. 
     7 
     8Copyright (c) 2010, UW-Madison LOCI 
     9All rights reserved. 
     10 
     11Redistribution and use in source and binary forms, with or without 
     12modification, are permitted provided that the following conditions are met: 
     13  * Redistributions of source code must retain the above copyright 
     14    notice, this list of conditions and the following disclaimer. 
     15  * Redistributions in binary form must reproduce the above copyright 
     16    notice, this list of conditions and the following disclaimer in the 
     17    documentation and/or other materials provided with the distribution. 
     18  * Neither the name of the UW-Madison LOCI nor the 
     19    names of its contributors may be used to endorse or promote products 
     20    derived from this software without specific prior written permission. 
     21 
     22THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
     23AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
     24IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
     25ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE 
     26LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
     27CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
     28SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
     29INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
     30CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
     31ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
     32POSSIBILITY OF SUCH DAMAGE. 
     33*/ 
    534 
    635package loci.multiinstanceplugin; 
     
    938 
    1039/** 
     40 * Interface for a Plugin.  Defines the main processing method that a plugin 
     41 * implements, as well as methods that are available to the plugin internally 
     42 * to get and put named images. 
    1143 * 
    1244 * @author Aivar Grislis 
     
    1547 
    1648    /** 
    17      * Gets the default input image from previous in chain.  Called from subclass. 
     49     * Gets the default input image from previous in chain.  Called from within 
     50     * implementation. 
    1851     * 
    1952     * @return image 
     
    2255 
    2356    /** 
    24      * Gets a named input image from previous in chain.  Called from subclass. 
     57     * Gets a named input image from previous in chain.  Called from within 
     58     * implemenation. 
    2559     * 
    2660     * @param inName 
     
    3064 
    3165    /** 
    32      * This is the body of the plugin, defined in subclass. 
     66     * This is the body of the plugin, defined in implemenation. 
    3367     */ 
    3468    void process(); 
    3569 
    3670    /** 
    37      * Puts the default output image to next in chain (if any).  Called from subclass. 
     71     * Puts the default output image to next in chain (if any).  Called from 
     72     * within implemenation. 
    3873     * 
    3974     * @param image 
     
    4277 
    4378    /** 
    44      * Puts named output image to next in chain (if any).  Called from subclass. 
     79     * Puts named output image to next in chain (if any).  Called from within 
     80     * implementation. 
    4581     * 
    4682     * @param outName 
Note: See TracChangeset for help on using the changeset viewer.