View Javadoc

1   /* This file is part of the project "Hilbert II" - http://www.qedeq.org" target="alexandria_uri">http://www.qedeq.org
2    *
3    * Copyright 2000-2014,  Michael Meyling <mime@qedeq.org>.
4    *
5    * "Hilbert II" is free software; you can redistribute
6    * it and/or modify it under the terms of the GNU General Public
7    * License as published by the Free Software Foundation; either
8    * version 2 of the License, or (at your option) any later version.
9    *
10   * This program is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13   * GNU General Public License for more details.
14   */
15  
16  package org.qedeq.kernel.se.base.module;
17  
18  /**
19   * Describes the "physical" directory location for a module.
20   * This is a full or relative URL like:
21   * <code>http://www.qedeq.org/principia/0_01_06/</code> or <code>.</code>
22   * or <code>file:///qedeq/</code>
23   *
24   * @author  Michael Meyling
25   */
26  public interface Location {
27  
28      /**
29       * Get location for a module. The <code>location</code>
30       * parameter contains an URL that points to a directory.
31       * This is a full or relative URL like:
32       * <code>http://www.qedeq.org/principia/0_01_06/</code> or <code>.</code>
33       * or <code>file:///qedeq/</code>
34       *
35       * @return  URL directory location.
36       */
37      public String getLocation();
38  }