BasicLibraryService


1   /***** BEGIN LICENSE BLOCK *****
2    * Version: CPL 1.0/GPL 2.0/LGPL 2.1
3    *
4    * The contents of this file are subject to the Common Public
5    * License Version 1.0 (the "License"); you may not use this file
6    * except in compliance with the License. You may obtain a copy of
7    * the License at http://www.eclipse.org/legal/cpl-v10.html
8    *
9    * Software distributed under the License is distributed on an "AS
10   * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
11   * implied. See the License for the specific language governing
12   * rights and limitations under the License.
13   *
14   * Copyright (C) 2006 Ola Bini <ola@ologix.com>
15   * 
16   * Alternatively, the contents of this file may be used under the terms of
17   * either of the GNU General Public License Version 2 or later (the "GPL"),
18   * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
19   * in which case the provisions of the GPL or the LGPL are applicable instead
20   * of those above. If you wish to allow use of your version of this file only
21   * under the terms of either the GPL or the LGPL, and not to allow others to
22   * use your version of this file under the terms of the CPL, indicate your
23   * decision by deleting the provisions above and replace them with the notice
24   * and other provisions required by the GPL or the LGPL. If you do not delete
25   * the provisions above, a recipient may use your version of this file under
26   * the terms of any one of the CPL, the GPL or the LGPL.
27   ***** END LICENSE BLOCK *****/
28  package org.jruby.runtime.load;
29  
30  import java.io.IOException  ;
31  import org.jruby.Ruby;
32  
33  /**
34   * This interface should be implemented by writers of Java extensions to JRuby.
35   * The basicLoad method will get called exactly once, the first time this extension
36   * gets loaded. It is therefore prudent that it established the environment
37   * the extension wants to have. For example, creating new Modules and Classes,
38   * adding methods to these and describe which implementation will get used.
39   *
40   * This interface details the standard load mechanism for easy extensions.
41   * Implement the interface in a class outlined in the JavaDoc for LoadService,
42   * put the class into a jar-file and put it on JRuby's load path, and you're
43   * set to go.
44   */
45  public interface BasicLibraryService {
46      boolean basicLoad(Ruby runtime) throws IOException  ;
47  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags