View Javadoc

1   ////////////////////////////////////////////////////////////////////////////////
2   // MillScript: an Open Spice interpreter and batch website creation tool
3   // Copyright (C) 2005 Kevin Rogers
4   //
5   // This file is part of MillScript.
6   //
7   // MillScript is free software; you can redistribute it and/or modify it under
8   // the terms of the GNU General Public License as published by the Free
9   // Software Foundation; either version 2 of the License, or (at your option)
10  // any later version.
11  //
12  // MillScript is distributed in the hope that it will be useful, but WITHOUT
13  // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14  // FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
15  // more details.
16  //
17  // You should have received a copy of the GNU General Public License along with
18  // MillScript; if not, write to the Free Software Foundation, Inc., 59 Temple
19  // Place, Suite 330, Boston, MA  02111-1307  USA
20  ////////////////////////////////////////////////////////////////////////////////
21  package org.millscript.commons.vfs.protocols;
22  
23  /**
24   * This interface defines a factory for URI scheme handlers. It is used within the
25   * VFS to determine the URISchemeHandler to use for a given scheme.
26   */
27  public interface URISchemeHandlerFactory {
28  
29      /**
30       * Returns a URISchemeHandler for the specified scheme.
31       *
32       * @param scheme    the scheme
33       * @return  a URISchemeHandler for the specified scheme, or
34       * <code>null</code> if there isn't one
35       */
36      abstract URISchemeHandler createURISchemeHandler( final String scheme );
37  
38      /**
39       * Returns a URISchemeHandler for the specified scheme. This method differs
40       * from <code>createURISchemeHandler</code> in that it will generate an
41       * alert if no handler is available.
42       *
43       * @param scheme    the scheme
44       * @return  a URISchemeHandler for the specified scheme
45       */
46      abstract URISchemeHandler getURISchemeHandler( final String scheme );
47  
48  }