IOSEnvironmentReader


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 Tim Azzopardi <tim@tigerfive.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.environment;
29  
30  import java.util.Map  ;
31  
32  import org.jruby.Ruby;
33  
34  public interface IOSEnvironmentReader {
35  
36      /**
37       * Get the operating system environment variables.
38       * 
39       * Returns an string map view of the current system environment. 
40       * If environment variables,are not supported, then null is returned.  (isEnvironmentAccessible() returns false).
41       * If there are no variables defined, then an empty Map is returned. 
42       * 
43       * @return the operating system environment variables in a Map<String,String>.
44       * @throws OSEnvironmentReaderExcepton if there is a problem accessing the environment variables.
45       */
46      Map   getVariables(Ruby runtime);
47  
48      /**
49       * Determines whether the OS environment variables are accessible using a given implementation.
50       * 
51       * @return  whether the OS environment variables are accessible.
52       */
53      boolean isAccessible(Ruby runtime);;
54  
55  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags