KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > script > ScriptEngineInfo


1 /*
2  * Copyright (c) 1998-2006 Caucho Technology -- all rights reserved
3  *
4  * This file is part of Resin(R) Open Source
5  *
6  * Each copy or derived work must preserve the copyright notice and this
7  * notice unmodified.
8  *
9  * Resin Open Source is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * Resin Open Source is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
17  * of NON-INFRINGEMENT. See the GNU General Public License for more
18  * details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with Resin Open Source; if not, write to the
22  *
23  * Free Software Foundation, Inc.
24  * 59 Temple Place, Suite 330
25  * Boston, MA 02111-1307 USA
26  *
27  * @author Scott Ferguson
28  */

29
30 package javax.script;
31
32 /**
33  * Metadata about the script engine.
34  */

35 public interface ScriptEngineInfo {
36   /**
37    * Returns the full name of the ScriptEngine.
38    */

39   public String JavaDoc getEngineName();
40
41   /**
42    * Returns the version of the ScriptEngine, e.g.
43    * Rhino Mozilla Javascript Engine.
44    */

45   public String JavaDoc getEngineVersion();
46
47   /**
48    * Returns an array of filename extensions normally used by this
49    * language.
50    */

51   public String JavaDoc []getExtensions();
52
53   /**
54    * Returns the mime-types for scripts for the engine.
55    */

56   public String JavaDoc []getMimeTypes();
57
58   /**
59    * Returns the short names for the scripts for the engine,
60    * e.g. {"javascript", "rhino"}
61    */

62   public String JavaDoc []getNames();
63
64   /**
65    * Returns the name of the supported language.
66    */

67   public String JavaDoc getLanguageName();
68
69   /**
70    * Returns the version of the scripting language.
71    */

72   public String JavaDoc getLanguageVersion();
73
74   /**
75    * Returns engine-specific properties.
76    *
77    * Predefined keys include:
78    * <ul>
79    * <li>ENGINE
80    * <li>ENGINE_VERSION
81    * <li>NAME
82    * <li>LANGUAGE
83    * <li>LANGUAGE_VERSION
84    * <li>THREADING
85    * </ul>
86    */

87   public Object JavaDoc getParameter(String JavaDoc key);
88
89   /**
90    * Returns a string which could invoke a method of a Java object.
91    */

92   public String JavaDoc getMethodCallSyntax(String JavaDoc obj, String JavaDoc m, String JavaDoc []args);
93
94   /**
95    * Returns a string which generates an output statement.
96    */

97   public String JavaDoc getOutputStatement(String JavaDoc toDisplay);
98
99   /**
100    * Returns a string which generates a valid program.
101    */

102   public String JavaDoc getProgram(String JavaDoc []statements);
103 }
104
105
Popular Tags