JAL-1648 Implemented in-memory caching for FTS (Uniprot & PDB) and Finder
[jalview.git] / src / jalview / io / cache / Cacheable.java
1 package jalview.io.cache;
2
3 import javax.swing.JComboBox;
4 import javax.swing.JComponent;
5
6 public interface Cacheable
7 {
8
9   /**
10    * method executed on cache initialisation
11    */
12   public void init();
13
14   /**
15    * Combo-box instance for the cache component
16    * 
17    * @return
18    */
19   public JComboBox<String> getCacheComboBox();
20
21   /**
22    * The unique key that will be used for storing user input for this cacheable
23    * in the cache dictionary
24    * 
25    * @return
26    */
27   public String getCacheKey();
28
29   /**
30    * Get next focusable component. Required to delegate focus while updating the
31    * cacheable component cache
32    * 
33    * @return
34    */
35   public JComponent getNextFocusableElement();
36
37 }