src/core/net/sf/basedb/util/extensions/ExtensionsFilter.java

Code
Comments
Other
Rev Date Author Line
4168 04 Mar 08 nicklas 1 /**
4479 05 Sep 08 jari 2   $Id$
4168 04 Mar 08 nicklas 3
4168 04 Mar 08 nicklas 4   Copyright (C) Authors contributing to this file.
4168 04 Mar 08 nicklas 5
4168 04 Mar 08 nicklas 6   This file is part of BASE - BioArray Software Environment.
4168 04 Mar 08 nicklas 7   Available at http://base.thep.lu.se/
4168 04 Mar 08 nicklas 8
4168 04 Mar 08 nicklas 9   BASE is free software; you can redistribute it and/or
4168 04 Mar 08 nicklas 10   modify it under the terms of the GNU General Public License
4479 05 Sep 08 jari 11   as published by the Free Software Foundation; either version 3
4168 04 Mar 08 nicklas 12   of the License, or (at your option) any later version.
4168 04 Mar 08 nicklas 13
4168 04 Mar 08 nicklas 14   BASE is distributed in the hope that it will be useful,
4168 04 Mar 08 nicklas 15   but WITHOUT ANY WARRANTY; without even the implied warranty of
4168 04 Mar 08 nicklas 16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
4168 04 Mar 08 nicklas 17   GNU General Public License for more details.
4168 04 Mar 08 nicklas 18
4168 04 Mar 08 nicklas 19   You should have received a copy of the GNU General Public License
4515 11 Sep 08 jari 20   along with BASE. If not, see <http://www.gnu.org/licenses/>.
4168 04 Mar 08 nicklas 21 */
4168 04 Mar 08 nicklas 22 package net.sf.basedb.util.extensions;
4168 04 Mar 08 nicklas 23
4168 04 Mar 08 nicklas 24 import java.util.List;
4168 04 Mar 08 nicklas 25
4168 04 Mar 08 nicklas 26 /**
4168 04 Mar 08 nicklas 27   Allows extensions and extension points to be enabled/disabled
4168 04 Mar 08 nicklas 28   and sorted externally. An object of this class is used by the
4207 04 Apr 08 nicklas 29   {@link Registry#useExtensions(ClientContext, ExtensionsFilter, String...)}
4168 04 Mar 08 nicklas 30   method.
4168 04 Mar 08 nicklas 31
4168 04 Mar 08 nicklas 32   @author nicklas
4168 04 Mar 08 nicklas 33   @version 2.7
4207 04 Apr 08 nicklas 34   @base.modified $Date:2008-03-20 12:15:25 +0100 (Thu, 20 Mar 2008) $
4168 04 Mar 08 nicklas 35 */
4168 04 Mar 08 nicklas 36 public interface ExtensionsFilter 
4168 04 Mar 08 nicklas 37 {
4168 04 Mar 08 nicklas 38
4168 04 Mar 08 nicklas 39   /**
4168 04 Mar 08 nicklas 40     Check if an extension point is enabled or disabled.
4168 04 Mar 08 nicklas 41     @param extensionPoint The extension point to check
4168 04 Mar 08 nicklas 42     @return TRUE if the extension point is enabled, FALSE if 
4168 04 Mar 08 nicklas 43       it is disabled
4168 04 Mar 08 nicklas 44   */
4170 07 Mar 08 nicklas 45   public boolean isEnabled(ExtensionPoint<?> extensionPoint);
4168 04 Mar 08 nicklas 46   
4168 04 Mar 08 nicklas 47   /**
4168 04 Mar 08 nicklas 48     Check if an extension is enabled or disabled.
4168 04 Mar 08 nicklas 49     @param extension The extension  to check
4168 04 Mar 08 nicklas 50     @return TRUE if the extension is enabled, FALSE if 
4168 04 Mar 08 nicklas 51       it is disabled
4168 04 Mar 08 nicklas 52   */
4170 07 Mar 08 nicklas 53   public boolean isEnabled(Extension<?> extension);
4168 04 Mar 08 nicklas 54   
4168 04 Mar 08 nicklas 55   /**
4207 04 Apr 08 nicklas 56     Sort a list of invoked extensions according to some property.
4168 04 Mar 08 nicklas 57     @param extensions The list of extensions to sort
4168 04 Mar 08 nicklas 58   */
4207 04 Apr 08 nicklas 59   public void sort(List<? extends InvokationContext<?>> extensions);
4168 04 Mar 08 nicklas 60   
4168 04 Mar 08 nicklas 61 }