JAL-3878 Add javadocs to created classes and reformat code.
[jalview.git] / src / jalview / ws2 / MenuEntryProviderI.java
1 package jalview.ws2;
2
3 import javax.swing.JMenu;
4
5 import jalview.gui.AlignFrame;
6
7 /**
8  * Functional interface provided by {@link jalview.ws2.operations.Operation}
9  * instances to construct the menu entry for the operations. The instances are
10  * passed to the {@link jalview.gui.WebServicesMenuBuilder} and called during
11  * menu construction.
12  * 
13  * @author mmwarowny
14  */
15 @FunctionalInterface
16 public interface MenuEntryProviderI
17 {
18   /**
19    * Build menu entries directly under the given menu. This method is called by
20    * {@link jalview.gui.WebServicesMenuBuilder} during menu construction.
21    * 
22    * @param parent
23    *          parent menu
24    * @param frame
25    *          current alignFrame
26    */
27   public void buildMenu(JMenu parent, AlignFrame frame);
28 }