org.jruby.runtime.load.BasicLibraryService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of killbill-osgi-bundles-jruby Show documentation

There is a newer version: 0.8.14

Show newest version

/***** BEGIN LICENSE BLOCK *****
 * Version: CPL 1.0/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Common Public
 * License Version 1.0 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy of
 * the License at http://www.eclipse.org/legal/cpl-v10.html
 *
 * Software distributed under the License is distributed on an "AS
 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * rights and limitations under the License.
 *
 * Copyright (C) 2006 Ola Bini 
 * 
 * Alternatively, the contents of this file may be used under the terms of
 * either of the GNU General Public License Version 2 or later (the "GPL"),
 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the CPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the CPL, the GPL or the LGPL.
 ***** END LICENSE BLOCK *****/
package org.jruby.runtime.load;

import java.io.IOException;
import org.jruby.Ruby;

/**
 * This interface should be implemented by writers of Java extensions to JRuby.
 * The basicLoad method will get called exactly once, the first time this extension
 * gets loaded. It is therefore prudent that it established the environment
 * the extension wants to have. For example, creating new Modules and Classes,
 * adding methods to these and describe which implementation will get used.
 *
 * This interface details the standard load mechanism for easy extensions.
 * Implement the interface in a class outlined in the JavaDoc for LoadService,
 * put the class into a jar-file and put it on JRuby's load path, and you're
 * set to go.
 */
public interface BasicLibraryService {
    boolean basicLoad(Ruby runtime) throws IOException;
}