This is an automated email from the ASF dual-hosted git repository. rombert pushed a commit to annotated tag org.apache.sling.scripting.api-2.1.0 in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-scripting-api.git
commit 2c8eb09028d0bc31efd4fbe04c3bf7d3d82cf5cf Author: Carsten Ziegeler <[email protected]> AuthorDate: Mon Feb 8 17:40:34 2010 +0000 Add some javadocs. git-svn-id: https://svn.apache.org/repos/asf/sling/trunk/bundles/scripting/api@907735 13f79535-47bb-0310-9956-ffa450edef68 --- .../scripting/api/AbstractScriptEngineFactory.java | 68 ++++++++++++++++++++-- .../scripting/api/BindingsValuesProvider.java | 3 +- 2 files changed, 64 insertions(+), 7 deletions(-) diff --git a/src/main/java/org/apache/sling/scripting/api/AbstractScriptEngineFactory.java b/src/main/java/org/apache/sling/scripting/api/AbstractScriptEngineFactory.java index bca637d..6889d93 100644 --- a/src/main/java/org/apache/sling/scripting/api/AbstractScriptEngineFactory.java +++ b/src/main/java/org/apache/sling/scripting/api/AbstractScriptEngineFactory.java @@ -29,17 +29,26 @@ import java.util.jar.Manifest; import javax.script.ScriptEngine; import javax.script.ScriptEngineFactory; -public abstract class AbstractScriptEngineFactory implements - ScriptEngineFactory { +/** + * This abstract class can be used for own script engine + * factory implementations. + */ +public abstract class AbstractScriptEngineFactory + implements ScriptEngineFactory { + /** The engine name. */ private String engineName; + /** The version of the engine. */ private String engineVersion; + /** List of extensions. */ private List<String> extensions; + /** List of mime types. */ private List<String> mimeTypes; + /** List of names. */ private List<String> names; protected AbstractScriptEngineFactory() { @@ -79,32 +88,53 @@ public abstract class AbstractScriptEngineFactory implements setEngineName(name); setEngineVersion(version); - + setExtensions((String[]) null); setMimeTypes((String[]) null); setNames((String[]) null); } + /** + * @see javax.script.ScriptEngineFactory#getEngineName() + */ public String getEngineName() { return engineName; } + /** + * Set the engine name. + * @param engineName The new engine name + */ protected void setEngineName(String engineName) { this.engineName = engineName; } + /** + * @see javax.script.ScriptEngineFactory#getEngineVersion() + */ public String getEngineVersion() { return engineVersion; } + /** + * Set the engine version + * @param engineVersion The version string + */ protected void setEngineVersion(String engineVersion) { this.engineVersion = engineVersion; } + /** + * @see javax.script.ScriptEngineFactory#getExtensions() + */ public List<String> getExtensions() { return extensions; } + /** + * Set the extensions + * @param extensions The array of extensions + */ protected void setExtensions(String... extensions) { if (extensions == null) { this.extensions = Collections.emptyList(); @@ -113,10 +143,17 @@ public abstract class AbstractScriptEngineFactory implements } } + /** + * @see javax.script.ScriptEngineFactory#getMimeTypes() + */ public List<String> getMimeTypes() { return mimeTypes; } + /** + * Set the mime types + * @param mimeTypes The array of mime types + */ protected void setMimeTypes(String... mimeTypes) { if (mimeTypes == null) { this.mimeTypes = Collections.emptyList(); @@ -125,10 +162,17 @@ public abstract class AbstractScriptEngineFactory implements } } + /** + * @see javax.script.ScriptEngineFactory#getNames() + */ public List<String> getNames() { return names; } + /** + * Set the names + * @param names The array of names. + */ protected void setNames(String... names) { if (names == null) { this.names = Collections.emptyList(); @@ -137,8 +181,11 @@ public abstract class AbstractScriptEngineFactory implements } } - public String getMethodCallSyntax(String obj, String m, String[] args) { - StringBuffer callSyntax = new StringBuffer(); + /** + * @see javax.script.ScriptEngineFactory#getMethodCallSyntax(java.lang.String, java.lang.String, java.lang.String[]) + */ + public String getMethodCallSyntax(String obj, String m, String... args) { + StringBuilder callSyntax = new StringBuilder(); callSyntax.append(obj).append('.').append(m).append('('); for (int i = 0; args != null && i < args.length; i++) { if (i > 0) callSyntax.append(','); @@ -148,10 +195,16 @@ public abstract class AbstractScriptEngineFactory implements return callSyntax.toString(); } + /** + * @see javax.script.ScriptEngineFactory#getOutputStatement(java.lang.String) + */ public String getOutputStatement(String value) { return "out.print(" + value + ")"; } + /** + * @see javax.script.ScriptEngineFactory#getParameter(java.lang.String) + */ public Object getParameter(String name) { if (ScriptEngine.ENGINE.equals(name)) { return getEngineName(); @@ -167,7 +220,10 @@ public abstract class AbstractScriptEngineFactory implements return null; } - public String getProgram(String[] arg0) { + /** + * @see javax.script.ScriptEngineFactory#getProgram(java.lang.String[]) + */ + public String getProgram(String... arg0) { return null; } diff --git a/src/main/java/org/apache/sling/scripting/api/BindingsValuesProvider.java b/src/main/java/org/apache/sling/scripting/api/BindingsValuesProvider.java index 54aeb37..a5b18b9 100644 --- a/src/main/java/org/apache/sling/scripting/api/BindingsValuesProvider.java +++ b/src/main/java/org/apache/sling/scripting/api/BindingsValuesProvider.java @@ -21,7 +21,8 @@ package org.apache.sling.scripting.api; import javax.script.Bindings; /** - * Service interface which allows for the Bindings object + * Service interface which allows for the Bindings object. + * @since 2.1 */ public interface BindingsValuesProvider { -- To stop receiving notification emails like this one, please contact "[email protected]" <[email protected]>.
