From 823fe183a93f54e88cb45686a6cf137529f29a2f Mon Sep 17 00:00:00 2001 From: "pedemont%us.ibm.com" Date: Wed, 27 Sep 2006 15:09:11 +0000 Subject: [PATCH] Bug 305815 - Better organize Java interfaces. Implement getGREPathWithProperties(). r=bsmedberg, r=lbustelo. Not part of default build. This file was copied in CVS from the following location: mozilla/extensions/java/xpcom/interfaces/IGRE.java Original committer: pedemont%us.ibm.com Original revision: 1.1 Original date: 2005/10/28 01:59:03 --- .../interfaces/org/mozilla/xpcom/IGRE.java | 80 +++++++++++++++++++ 1 file changed, 80 insertions(+) create mode 100644 extensions/java/xpcom/interfaces/org/mozilla/xpcom/IGRE.java diff --git a/extensions/java/xpcom/interfaces/org/mozilla/xpcom/IGRE.java b/extensions/java/xpcom/interfaces/org/mozilla/xpcom/IGRE.java new file mode 100644 index 00000000000..fd956c81dc6 --- /dev/null +++ b/extensions/java/xpcom/interfaces/org/mozilla/xpcom/IGRE.java @@ -0,0 +1,80 @@ +/* ***** BEGIN LICENSE BLOCK ***** + * Version: MPL 1.1/GPL 2.0/LGPL 2.1 + * + * The contents of this file are subject to the Mozilla Public License Version + * 1.1 (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.mozilla.org/MPL/ + * + * 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. + * + * The Original Code is Java XPCOM Bindings. + * + * The Initial Developer of the Original Code is + * IBM Corporation. + * Portions created by the Initial Developer are Copyright (C) 2004 + * IBM Corporation. All Rights Reserved. + * + * Contributor(s): + * Javier Pedemonte (jhpedemonte@gmail.com) + * + * Alternatively, the contents of this file may be used under the terms of + * either 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 MPL, 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 MPL, the GPL or the LGPL. + * + * ***** END LICENSE BLOCK ***** */ + +package org.mozilla.xpcom; + +import java.io.*; + + +public interface IGRE { + + /** + * Initializes libXUL for embedding purposes. + *

+ * NOTE: This function must be called from the "main" thread. + *

+ * NOTE: At the present time, this function may only be called once in + * a given process. Use termEmbedding to clean up and free + * resources allocated by initEmbedding. + * + * @param aLibXULDirectory The directory in which the libXUL shared library + * was found. + * @param aAppDirectory The directory in which the application components + * and resources can be found. This will map to + * the "resource:app" directory service key. + * @param aAppDirProvider A directory provider for the application. This + * provider will be aggregated by a libXUL provider + * which will provide the base required GRE keys. + * + * @throws XPCOMException if a failure occurred during initialization + */ + public void initEmbedding(File aLibXULDirectory, File aAppDirectory, + IAppFileLocProvider aAppDirProvider) throws XPCOMException; + + /** + * Terminates libXUL embedding. + *

+ * NOTE: Release any references to XPCOM objects that you may be holding + * before calling this function. + * + * @throws XPCOMException if a failure occurred during initialization + */ + public void termEmbedding() throws XPCOMException; + +} + +