http://git-wip-us.apache.org/repos/asf/sling-site/blob/c1fb7b2c/apidocs/sling5/org/apache/sling/api/scripting/ScriptEvaluationException.html ---------------------------------------------------------------------- diff --git a/apidocs/sling5/org/apache/sling/api/scripting/ScriptEvaluationException.html b/apidocs/sling5/org/apache/sling/api/scripting/ScriptEvaluationException.html new file mode 100644 index 0000000..47af8c4 --- /dev/null +++ b/apidocs/sling5/org/apache/sling/api/scripting/ScriptEvaluationException.html @@ -0,0 +1,297 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.6.0_10) on Mon May 11 08:55:04 CEST 2009 --> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<TITLE> +ScriptEvaluationException (Apache Sling Aggregate 5-incubator API) +</TITLE> + +<META NAME="date" CONTENT="2009-05-11"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ScriptEvaluationException (Apache Sling Aggregate 5-incubator API)"; + } +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> +<HR> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ScriptEvaluationException.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../org/apache/sling/api/scripting/InvalidServiceFilterSyntaxException.html" title="class in org.apache.sling.api.scripting"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html" title="class in org.apache.sling.api.scripting"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/sling/api/scripting/ScriptEvaluationException.html" target="_top"><B>FRAMES</B></A> + <A HREF="ScriptEvaluationException.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +org.apache.sling.api.scripting</FONT> +<BR> +Class ScriptEvaluationException</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.Exception + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.RuntimeException + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/sling/api/SlingException.html" title="class in org.apache.sling.api">org.apache.sling.api.SlingException</A> + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.sling.api.scripting.ScriptEvaluationException</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD> +</DL> +<HR> +<DL> +<DT><PRE>public class <B>ScriptEvaluationException</B><DT>extends <A HREF="../../../../../org/apache/sling/api/SlingException.html" title="class in org.apache.sling.api">SlingException</A></DL> +</PRE> + +<P> +The <code>ScriptEvaluationException</code> is thrown by the + <A HREF="../../../../../org/apache/sling/api/scripting/SlingScript.html#eval(org.apache.sling.api.scripting.SlingBindings)"><CODE>SlingScript.eval(SlingBindings)</CODE></A> method if an error occurrs evaluating + the script. +<P> + +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../serialized-form.html#org.apache.sling.api.scripting.ScriptEvaluationException">Serialized Form</A></DL> +<HR> + +<P> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/ScriptEvaluationException.html#ScriptEvaluationException(java.lang.String, java.lang.String)">ScriptEvaluationException</A></B>(java.lang.String scriptName, + java.lang.String message)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/ScriptEvaluationException.html#ScriptEvaluationException(java.lang.String, java.lang.String, java.lang.Throwable)">ScriptEvaluationException</A></B>(java.lang.String scriptName, + java.lang.String message, + java.lang.Throwable cause)</CODE> + +<BR> + </TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/ScriptEvaluationException.html#getScriptName()">getScriptName</A></B>()</CODE> + +<BR> + </TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Throwable</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</CODE></TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="ScriptEvaluationException(java.lang.String, java.lang.String)"><!-- --></A><H3> +ScriptEvaluationException</H3> +<PRE> +public <B>ScriptEvaluationException</B>(java.lang.String scriptName, + java.lang.String message)</PRE> +<DL> +</DL> +<HR> + +<A NAME="ScriptEvaluationException(java.lang.String, java.lang.String, java.lang.Throwable)"><!-- --></A><H3> +ScriptEvaluationException</H3> +<PRE> +public <B>ScriptEvaluationException</B>(java.lang.String scriptName, + java.lang.String message, + java.lang.Throwable cause)</PRE> +<DL> +</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="getScriptName()"><!-- --></A><H3> +getScriptName</H3> +<PRE> +public java.lang.String <B>getScriptName</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ScriptEvaluationException.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../org/apache/sling/api/scripting/InvalidServiceFilterSyntaxException.html" title="class in org.apache.sling.api.scripting"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html" title="class in org.apache.sling.api.scripting"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/sling/api/scripting/ScriptEvaluationException.html" target="_top"><B>FRAMES</B></A> + <A HREF="ScriptEvaluationException.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> +Copyright © 2007-2009. All Rights Reserved. +</BODY> +</HTML>
http://git-wip-us.apache.org/repos/asf/sling-site/blob/c1fb7b2c/apidocs/sling5/org/apache/sling/api/scripting/SlingBindings.html ---------------------------------------------------------------------- diff --git a/apidocs/sling5/org/apache/sling/api/scripting/SlingBindings.html b/apidocs/sling5/org/apache/sling/api/scripting/SlingBindings.html new file mode 100644 index 0000000..a4e4c3a --- /dev/null +++ b/apidocs/sling5/org/apache/sling/api/scripting/SlingBindings.html @@ -0,0 +1,978 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.6.0_10) on Mon May 11 08:55:04 CEST 2009 --> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<TITLE> +SlingBindings (Apache Sling Aggregate 5-incubator API) +</TITLE> + +<META NAME="date" CONTENT="2009-05-11"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SlingBindings (Apache Sling Aggregate 5-incubator API)"; + } +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> +<HR> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SlingBindings.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../org/apache/sling/api/scripting/ScriptEvaluationException.html" title="class in org.apache.sling.api.scripting"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/sling/api/scripting/SlingScript.html" title="interface in org.apache.sling.api.scripting"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/sling/api/scripting/SlingBindings.html" target="_top"><B>FRAMES</B></A> + <A HREF="SlingBindings.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: <A HREF="#nested_classes_inherited_from_class_java.util.AbstractMap">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +org.apache.sling.api.scripting</FONT> +<BR> +Class SlingBindings</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.util.AbstractMap<K,V> + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.util.HashMap<java.lang.String,java.lang.Object> + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.sling.api.scripting.SlingBindings</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object></DD> +</DL> +<HR> +<DL> +<DT><PRE>public class <B>SlingBindings</B><DT>extends java.util.HashMap<java.lang.String,java.lang.Object></DL> +</PRE> + +<P> +The <code>SlingBindings</code> class is used to prepare global variables + for script execution. The constants in this class define names of variables + which <em>MUST</em> or <em>MAY</em> be provided for the script execution. + Other variables may be define as callers see fit. +<P> + +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../serialized-form.html#org.apache.sling.api.scripting.SlingBindings">Serialized Form</A></DL> +<HR> + +<P> +<!-- ======== NESTED CLASS SUMMARY ======== --> + +<A NAME="nested_class_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Nested Class Summary</B></FONT></TH> +</TR> +</TABLE> + <A NAME="nested_classes_inherited_from_class_java.util.AbstractMap"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Nested classes/interfaces inherited from class java.util.AbstractMap</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V></CODE></TD> +</TR> +</TABLE> + +<!-- =========== FIELD SUMMARY =========== --> + +<A NAME="field_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Field Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#FLUSH">FLUSH</A></B></CODE> + +<BR> + The name of the global scripting variable indicating whether the output + used by the script should be flushed after the script evaluation ended + normally (value is "flush").</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#LOG">LOG</A></B></CODE> + +<BR> + The name of the global scripting variable providing a logger which may be + used for logging purposes (value is "log").</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#OUT">OUT</A></B></CODE> + +<BR> + The name of the global scripting variable providing the + <code>java.io.PrintWriter</code> object to return the response content + (value is "out").</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#READER">READER</A></B></CODE> + +<BR> + The name of the global scripting variable providing the + <CODE>Reader</CODE> object (value is "reader").</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#REQUEST">REQUEST</A></B></CODE> + +<BR> + The name of the global scripting variable providing the + <A HREF="../../../../../org/apache/sling/api/SlingHttpServletRequest.html" title="interface in org.apache.sling.api"><CODE>SlingHttpServletRequest</CODE></A> object (value is + "request").</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#RESOURCE">RESOURCE</A></B></CODE> + +<BR> + The name of the global scripting variable providing the + <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> object (value is + "resource").</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#RESPONSE">RESPONSE</A></B></CODE> + +<BR> + The name of the global scripting variable providing the + <A HREF="../../../../../org/apache/sling/api/SlingHttpServletResponse.html" title="interface in org.apache.sling.api"><CODE>SlingHttpServletResponse</CODE></A> object (value is + "response").</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#SLING">SLING</A></B></CODE> + +<BR> + The name of the global scripting variable providing the + <A HREF="../../../../../org/apache/sling/api/scripting/SlingScriptHelper.html" title="interface in org.apache.sling.api.scripting"><CODE>SlingScriptHelper</CODE></A> for the request + (value is "sling").</TD> +</TR> +</TABLE> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#SlingBindings()">SlingBindings</A></B>()</CODE> + +<BR> + </TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> +<TR ALIGN="right" VALIGN=""> +<TD NOWRAP><FONT SIZE="-1"> +<CODE><ObjectType> +<BR> +ObjectType</CODE></FONT></TD> +</TR> +</TABLE> +</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#get(java.lang.String, java.lang.Class)">get</A></B>(java.lang.String key, + java.lang.Class<ObjectType> type)</CODE> + +<BR> + Helper method to get an object with a given type from this map.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#getFlush()">getFlush</A></B>()</CODE> + +<BR> + Returns the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#FLUSH"><CODE>FLUSH</CODE></A> property if not <code>null</code> and a + <code>boolean</code>.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> org.slf4j.Logger</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#getLog()">getLog</A></B>()</CODE> + +<BR> + Returns the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#LOG"><CODE>LOG</CODE></A> property if not <code>null</code> and a + <code>org.slf4j.Logger</code> instance.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.io.PrintWriter</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#getOut()">getOut</A></B>()</CODE> + +<BR> + Returns the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#OUT"><CODE>OUT</CODE></A> property if not <code>null</code> and a + <code>PrintWriter</code> instance.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.io.Reader</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#getReader()">getReader</A></B>()</CODE> + +<BR> + Returns the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#READER"><CODE>READER</CODE></A> property if not <code>null</code> and a + <code>Reader</code> instance.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../../org/apache/sling/api/SlingHttpServletRequest.html" title="interface in org.apache.sling.api">SlingHttpServletRequest</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#getRequest()">getRequest</A></B>()</CODE> + +<BR> + Returns the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#REQUEST"><CODE>REQUEST</CODE></A> property if not <code>null</code> and a + <code>SlingHttpServletRequest</code> instance.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#getResource()">getResource</A></B>()</CODE> + +<BR> + Returns the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#RESOURCE"><CODE>RESOURCE</CODE></A> property if not <code>null</code> and a + <code>Resource</code> instance.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../../org/apache/sling/api/SlingHttpServletResponse.html" title="interface in org.apache.sling.api">SlingHttpServletResponse</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#getResponse()">getResponse</A></B>()</CODE> + +<BR> + Returns the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#RESPONSE"><CODE>RESPONSE</CODE></A> property if not <code>null</code> and a + <code>SlingHttpServletResponse</code> instance.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../../org/apache/sling/api/scripting/SlingScriptHelper.html" title="interface in org.apache.sling.api.scripting">SlingScriptHelper</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#getSling()">getSling</A></B>()</CODE> + +<BR> + Returns the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#SLING"><CODE>SLING</CODE></A> property if not <code>null</code> and a + <code>SlingScriptHelper</code> instance.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#safePut(java.lang.String, java.lang.Object)">safePut</A></B>(java.lang.String key, + java.lang.Object value)</CODE> + +<BR> + Helper method which invokes <CODE>HashMap.put(Object, Object)</CODE> only if the value is not null.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#setFlush(boolean)">setFlush</A></B>(boolean flush)</CODE> + +<BR> + Sets the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#FLUSH"><CODE>FLUSH</CODE></A> property to <code>flush</code>.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#setLog(org.slf4j.Logger)">setLog</A></B>(org.slf4j.Logger log)</CODE> + +<BR> + Sets the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#LOG"><CODE>LOG</CODE></A> property to <code>log</code> if not + <code>null</code>.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#setOut(java.io.PrintWriter)">setOut</A></B>(java.io.PrintWriter out)</CODE> + +<BR> + Sets the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#OUT"><CODE>OUT</CODE></A> property to <code>out</code> if not + <code>null</code>.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#setReader(java.io.Reader)">setReader</A></B>(java.io.Reader reader)</CODE> + +<BR> + Sets the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#READER"><CODE>READER</CODE></A> property to <code>reader</code> if not + <code>null</code>.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#setRequest(org.apache.sling.api.SlingHttpServletRequest)">setRequest</A></B>(<A HREF="../../../../../org/apache/sling/api/SlingHttpServletRequest.html" title="interface in org.apache.sling.api">SlingHttpServletRequest</A> request)</CODE> + +<BR> + Sets the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#REQUEST"><CODE>REQUEST</CODE></A> property to <code>request</code> if not + <code>null</code>.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#setResource(org.apache.sling.api.resource.Resource)">setResource</A></B>(<A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A> resource)</CODE> + +<BR> + Sets the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#RESOURCE"><CODE>RESOURCE</CODE></A> property to <code>resource</code> if not + <code>null</code>.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#setResponse(org.apache.sling.api.SlingHttpServletResponse)">setResponse</A></B>(<A HREF="../../../../../org/apache/sling/api/SlingHttpServletResponse.html" title="interface in org.apache.sling.api">SlingHttpServletResponse</A> response)</CODE> + +<BR> + Sets the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#RESPONSE"><CODE>RESPONSE</CODE></A> property to <code>response</code> if not + <code>null</code>.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#setSling(org.apache.sling.api.scripting.SlingScriptHelper)">setSling</A></B>(<A HREF="../../../../../org/apache/sling/api/scripting/SlingScriptHelper.html" title="interface in org.apache.sling.api.scripting">SlingScriptHelper</A> sling)</CODE> + +<BR> + Sets the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#SLING"><CODE>SLING</CODE></A> property to <code>sling</code> if not + <code>null</code>.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.util.HashMap"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.util.HashMap</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values</CODE></TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.util.AbstractMap"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.util.AbstractMap</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>equals, hashCode, toString</CODE></TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>finalize, getClass, notify, notifyAll, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.util.Map"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from interface java.util.Map</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>equals, hashCode</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ============ FIELD DETAIL =========== --> + +<A NAME="field_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Field Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="REQUEST"><!-- --></A><H3> +REQUEST</H3> +<PRE> +public static final java.lang.String <B>REQUEST</B></PRE> +<DL> +<DD>The name of the global scripting variable providing the + <A HREF="../../../../../org/apache/sling/api/SlingHttpServletRequest.html" title="interface in org.apache.sling.api"><CODE>SlingHttpServletRequest</CODE></A> object (value is + "request"). The value of the scripting variable is the same as that + returned by the + <A HREF="../../../../../org/apache/sling/api/scripting/SlingScriptHelper.html#getRequest()"><CODE>SlingScriptHelper.getRequest()</CODE></A> + method. + <p> + This bound variable is required in the bindings given the script. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.scripting.SlingBindings.REQUEST">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="RESPONSE"><!-- --></A><H3> +RESPONSE</H3> +<PRE> +public static final java.lang.String <B>RESPONSE</B></PRE> +<DL> +<DD>The name of the global scripting variable providing the + <A HREF="../../../../../org/apache/sling/api/SlingHttpServletResponse.html" title="interface in org.apache.sling.api"><CODE>SlingHttpServletResponse</CODE></A> object (value is + "response"). The value of the scripting variable is the same as that + returned by the + <A HREF="../../../../../org/apache/sling/api/scripting/SlingScriptHelper.html#getResponse()"><CODE>SlingScriptHelper.getResponse()</CODE></A> + method. + <p> + This bound variable is required in the bindings given the script. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.scripting.SlingBindings.RESPONSE">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="READER"><!-- --></A><H3> +READER</H3> +<PRE> +public static final java.lang.String <B>READER</B></PRE> +<DL> +<DD>The name of the global scripting variable providing the + <CODE>Reader</CODE> object (value is "reader"). + <p> + This bound variable is required in the bindings given the script. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.scripting.SlingBindings.READER">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="SLING"><!-- --></A><H3> +SLING</H3> +<PRE> +public static final java.lang.String <B>SLING</B></PRE> +<DL> +<DD>The name of the global scripting variable providing the + <A HREF="../../../../../org/apache/sling/api/scripting/SlingScriptHelper.html" title="interface in org.apache.sling.api.scripting"><CODE>SlingScriptHelper</CODE></A> for the request + (value is "sling"). + <p> + This bound variable is optional. If existing, the script helper instance + must be bound to the same request and response objects as bound with the + <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#REQUEST"><CODE>REQUEST</CODE></A> and <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#RESPONSE"><CODE>RESPONSE</CODE></A> variables. If this variable is not + bound, the script implementation will create it before actually + evaluating the script. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.scripting.SlingBindings.SLING">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="RESOURCE"><!-- --></A><H3> +RESOURCE</H3> +<PRE> +public static final java.lang.String <B>RESOURCE</B></PRE> +<DL> +<DD>The name of the global scripting variable providing the + <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource"><CODE>Resource</CODE></A> object (value is + "resource"). The value of the scripting variable is the same as that + returned by the <code>SlingScriptHelper.getRequest().getResource()</code> + method. + <p> + This bound variable is optional. If existing, the resource must be bound + to the same resource as returned by the + <code>SlingHttpServletRequest.getResource()</code> method. If this + variable is not bound, the script implementation will bind it before + actually evaluating the script. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.scripting.SlingBindings.RESOURCE">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="OUT"><!-- --></A><H3> +OUT</H3> +<PRE> +public static final java.lang.String <B>OUT</B></PRE> +<DL> +<DD>The name of the global scripting variable providing the + <code>java.io.PrintWriter</code> object to return the response content + (value is "out"). The value of the scripting variable is the same as that + returned by the <code>SlingScriptHelper.getResponse().getWriter()</code> + method. + <p> + Note, that it may be advisable to implement a lazy acquiring writer for + the <em>out</em> variable to enable the script to write binary data to + the response output stream instead of the writer. + <p> + This bound variable is optional. If existing, the resource must be bound + to the same writer as returned by the + <code>SlingHttpServletResponse.getWriter()</code> method of the + response object bound to the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#RESPONSE"><CODE>RESPONSE</CODE></A> variable. If this variable + is not bound, the script implementation will bind it before actually + evaluating the script. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.scripting.SlingBindings.OUT">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="FLUSH"><!-- --></A><H3> +FLUSH</H3> +<PRE> +public static final java.lang.String <B>FLUSH</B></PRE> +<DL> +<DD>The name of the global scripting variable indicating whether the output + used by the script should be flushed after the script evaluation ended + normally (value is "flush"). + <p> + The type of this variable is <code>java.lang.Boolean</code> indicating + whether to flush the output (value is <code>TRUE</code>) or not (value + is <code>FALSE</code>). If the variable has a non-<code>null</code> + value of another type, the output is not flush as if the value would be + <code>FALSE</code>. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.scripting.SlingBindings.FLUSH">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="LOG"><!-- --></A><H3> +LOG</H3> +<PRE> +public static final java.lang.String <B>LOG</B></PRE> +<DL> +<DD>The name of the global scripting variable providing a logger which may be + used for logging purposes (value is "log"). The logger provides the API + defined by the SLF4J <code>org.slf4j.Logger</code> interface. + <p> + This bound variable is optional. If this variable is not bound, the + script implementation will bind it before actually evaluating the script. +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.sling.api.scripting.SlingBindings.LOG">Constant Field Values</A></DL> +</DL> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="SlingBindings()"><!-- --></A><H3> +SlingBindings</H3> +<PRE> +public <B>SlingBindings</B>()</PRE> +<DL> +</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="get(java.lang.String, java.lang.Class)"><!-- --></A><H3> +get</H3> +<PRE> +protected <ObjectType> ObjectType <B>get</B>(java.lang.String key, + java.lang.Class<ObjectType> type)</PRE> +<DL> +<DD>Helper method to get an object with a given type from this map. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>The searched object if it has the specified type, otherwise <code>null</code> is returned.</DL> +</DD> +</DL> +<HR> + +<A NAME="safePut(java.lang.String, java.lang.Object)"><!-- --></A><H3> +safePut</H3> +<PRE> +protected void <B>safePut</B>(java.lang.String key, + java.lang.Object value)</PRE> +<DL> +<DD>Helper method which invokes <CODE>HashMap.put(Object, Object)</CODE> only if the value is not null. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setFlush(boolean)"><!-- --></A><H3> +setFlush</H3> +<PRE> +public void <B>setFlush</B>(boolean flush)</PRE> +<DL> +<DD>Sets the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#FLUSH"><CODE>FLUSH</CODE></A> property to <code>flush</code>. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getFlush()"><!-- --></A><H3> +getFlush</H3> +<PRE> +public boolean <B>getFlush</B>()</PRE> +<DL> +<DD>Returns the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#FLUSH"><CODE>FLUSH</CODE></A> property if not <code>null</code> and a + <code>boolean</code>. Otherwise <code>false</code> is returned. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setLog(org.slf4j.Logger)"><!-- --></A><H3> +setLog</H3> +<PRE> +public void <B>setLog</B>(org.slf4j.Logger log)</PRE> +<DL> +<DD>Sets the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#LOG"><CODE>LOG</CODE></A> property to <code>log</code> if not + <code>null</code>. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getLog()"><!-- --></A><H3> +getLog</H3> +<PRE> +public org.slf4j.Logger <B>getLog</B>()</PRE> +<DL> +<DD>Returns the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#LOG"><CODE>LOG</CODE></A> property if not <code>null</code> and a + <code>org.slf4j.Logger</code> instance. Otherwise <code>null</code> + is returned. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setOut(java.io.PrintWriter)"><!-- --></A><H3> +setOut</H3> +<PRE> +public void <B>setOut</B>(java.io.PrintWriter out)</PRE> +<DL> +<DD>Sets the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#OUT"><CODE>OUT</CODE></A> property to <code>out</code> if not + <code>null</code>. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getOut()"><!-- --></A><H3> +getOut</H3> +<PRE> +public java.io.PrintWriter <B>getOut</B>()</PRE> +<DL> +<DD>Returns the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#OUT"><CODE>OUT</CODE></A> property if not <code>null</code> and a + <code>PrintWriter</code> instance. Otherwise <code>null</code> is + returned. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setRequest(org.apache.sling.api.SlingHttpServletRequest)"><!-- --></A><H3> +setRequest</H3> +<PRE> +public void <B>setRequest</B>(<A HREF="../../../../../org/apache/sling/api/SlingHttpServletRequest.html" title="interface in org.apache.sling.api">SlingHttpServletRequest</A> request)</PRE> +<DL> +<DD>Sets the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#REQUEST"><CODE>REQUEST</CODE></A> property to <code>request</code> if not + <code>null</code>. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getRequest()"><!-- --></A><H3> +getRequest</H3> +<PRE> +public <A HREF="../../../../../org/apache/sling/api/SlingHttpServletRequest.html" title="interface in org.apache.sling.api">SlingHttpServletRequest</A> <B>getRequest</B>()</PRE> +<DL> +<DD>Returns the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#REQUEST"><CODE>REQUEST</CODE></A> property if not <code>null</code> and a + <code>SlingHttpServletRequest</code> instance. Otherwise + <code>null</code> is returned. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setReader(java.io.Reader)"><!-- --></A><H3> +setReader</H3> +<PRE> +public void <B>setReader</B>(java.io.Reader reader)</PRE> +<DL> +<DD>Sets the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#READER"><CODE>READER</CODE></A> property to <code>reader</code> if not + <code>null</code>. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getReader()"><!-- --></A><H3> +getReader</H3> +<PRE> +public java.io.Reader <B>getReader</B>()</PRE> +<DL> +<DD>Returns the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#READER"><CODE>READER</CODE></A> property if not <code>null</code> and a + <code>Reader</code> instance. Otherwise <code>null</code> is + returned. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setResource(org.apache.sling.api.resource.Resource)"><!-- --></A><H3> +setResource</H3> +<PRE> +public void <B>setResource</B>(<A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A> resource)</PRE> +<DL> +<DD>Sets the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#RESOURCE"><CODE>RESOURCE</CODE></A> property to <code>resource</code> if not + <code>null</code>. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getResource()"><!-- --></A><H3> +getResource</H3> +<PRE> +public <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A> <B>getResource</B>()</PRE> +<DL> +<DD>Returns the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#RESOURCE"><CODE>RESOURCE</CODE></A> property if not <code>null</code> and a + <code>Resource</code> instance. Otherwise <code>null</code> is + returned. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setResponse(org.apache.sling.api.SlingHttpServletResponse)"><!-- --></A><H3> +setResponse</H3> +<PRE> +public void <B>setResponse</B>(<A HREF="../../../../../org/apache/sling/api/SlingHttpServletResponse.html" title="interface in org.apache.sling.api">SlingHttpServletResponse</A> response)</PRE> +<DL> +<DD>Sets the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#RESPONSE"><CODE>RESPONSE</CODE></A> property to <code>response</code> if not + <code>null</code>. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getResponse()"><!-- --></A><H3> +getResponse</H3> +<PRE> +public <A HREF="../../../../../org/apache/sling/api/SlingHttpServletResponse.html" title="interface in org.apache.sling.api">SlingHttpServletResponse</A> <B>getResponse</B>()</PRE> +<DL> +<DD>Returns the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#RESPONSE"><CODE>RESPONSE</CODE></A> property if not <code>null</code> and a + <code>SlingHttpServletResponse</code> instance. Otherwise + <code>null</code> is returned. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setSling(org.apache.sling.api.scripting.SlingScriptHelper)"><!-- --></A><H3> +setSling</H3> +<PRE> +public void <B>setSling</B>(<A HREF="../../../../../org/apache/sling/api/scripting/SlingScriptHelper.html" title="interface in org.apache.sling.api.scripting">SlingScriptHelper</A> sling)</PRE> +<DL> +<DD>Sets the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#SLING"><CODE>SLING</CODE></A> property to <code>sling</code> if not + <code>null</code>. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getSling()"><!-- --></A><H3> +getSling</H3> +<PRE> +public <A HREF="../../../../../org/apache/sling/api/scripting/SlingScriptHelper.html" title="interface in org.apache.sling.api.scripting">SlingScriptHelper</A> <B>getSling</B>()</PRE> +<DL> +<DD>Returns the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html#SLING"><CODE>SLING</CODE></A> property if not <code>null</code> and a + <code>SlingScriptHelper</code> instance. Otherwise <code>null</code> + is returned. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SlingBindings.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../org/apache/sling/api/scripting/ScriptEvaluationException.html" title="class in org.apache.sling.api.scripting"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/sling/api/scripting/SlingScript.html" title="interface in org.apache.sling.api.scripting"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/sling/api/scripting/SlingBindings.html" target="_top"><B>FRAMES</B></A> + <A HREF="SlingBindings.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: <A HREF="#nested_classes_inherited_from_class_java.util.AbstractMap">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> +Copyright © 2007-2009. All Rights Reserved. +</BODY> +</HTML> http://git-wip-us.apache.org/repos/asf/sling-site/blob/c1fb7b2c/apidocs/sling5/org/apache/sling/api/scripting/SlingScript.html ---------------------------------------------------------------------- diff --git a/apidocs/sling5/org/apache/sling/api/scripting/SlingScript.html b/apidocs/sling5/org/apache/sling/api/scripting/SlingScript.html new file mode 100644 index 0000000..112f6dd --- /dev/null +++ b/apidocs/sling5/org/apache/sling/api/scripting/SlingScript.html @@ -0,0 +1,287 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.6.0_10) on Mon May 11 08:55:04 CEST 2009 --> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<TITLE> +SlingScript (Apache Sling Aggregate 5-incubator API) +</TITLE> + +<META NAME="date" CONTENT="2009-05-11"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SlingScript (Apache Sling Aggregate 5-incubator API)"; + } +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> +<HR> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SlingScript.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html" title="class in org.apache.sling.api.scripting"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/sling/api/scripting/SlingScriptHelper.html" title="interface in org.apache.sling.api.scripting"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/sling/api/scripting/SlingScript.html" target="_top"><B>FRAMES</B></A> + <A HREF="SlingScript.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +org.apache.sling.api.scripting</FONT> +<BR> +Interface SlingScript</H2> +<HR> +<DL> +<DT><PRE>public interface <B>SlingScript</B></DL> +</PRE> + +<P> +The <code>SlingScript</code> defines the API for objects which encapsulate + a script resolved by the <A HREF="../../../../../org/apache/sling/api/scripting/SlingScriptResolver.html" title="interface in org.apache.sling.api.scripting"><CODE>SlingScriptResolver</CODE></A>. To have a script + evaluated prepare a <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html" title="class in org.apache.sling.api.scripting"><CODE>SlingBindings</CODE></A> instance of variables used as + global variables to the script and call the <A HREF="../../../../../org/apache/sling/api/scripting/SlingScript.html#eval(org.apache.sling.api.scripting.SlingBindings)"><CODE>eval(SlingBindings)</CODE></A> + method. + <p> + Objects implementing this interface are returned by the + <A HREF="../../../../../org/apache/sling/api/scripting/SlingScriptResolver.html#findScript(org.apache.sling.api.resource.ResourceResolver, java.lang.String)"><CODE>SlingScriptResolver.findScript(org.apache.sling.api.resource.ResourceResolver, String)</CODE></A> + method. +<P> + +<P> +<HR> + +<P> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingScript.html#call(org.apache.sling.api.scripting.SlingBindings, java.lang.String, java.lang.Object...)">call</A></B>(<A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html" title="class in org.apache.sling.api.scripting">SlingBindings</A> props, + java.lang.String method, + java.lang.Object... args)</CODE> + +<BR> + Evaluates this script using the bound variables as global variables to + the script and then calls the given method with the arguments.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingScript.html#eval(org.apache.sling.api.scripting.SlingBindings)">eval</A></B>(<A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html" title="class in org.apache.sling.api.scripting">SlingBindings</A> props)</CODE> + +<BR> + Evaluates this script using the bound variables as global variables to + the script.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/sling/api/scripting/SlingScript.html#getScriptResource()">getScriptResource</A></B>()</CODE> + +<BR> + Returns the Resource providing the script source code.</TD> +</TR> +</TABLE> + +<P> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="getScriptResource()"><!-- --></A><H3> +getScriptResource</H3> +<PRE> +<A HREF="../../../../../org/apache/sling/api/resource/Resource.html" title="interface in org.apache.sling.api.resource">Resource</A> <B>getScriptResource</B>()</PRE> +<DL> +<DD>Returns the Resource providing the script source code. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="eval(org.apache.sling.api.scripting.SlingBindings)"><!-- --></A><H3> +eval</H3> +<PRE> +java.lang.Object <B>eval</B>(<A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html" title="class in org.apache.sling.api.scripting">SlingBindings</A> props)</PRE> +<DL> +<DD>Evaluates this script using the bound variables as global variables to + the script. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>props</CODE> - The <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html" title="class in org.apache.sling.api.scripting"><CODE>SlingBindings</CODE></A> providing the bound variables for + evaluating the script. Any bound variables must conform to the + requirements of the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html" title="class in org.apache.sling.api.scripting"><CODE>SlingBindings</CODE></A> predefined variables + set. +<DT><B>Returns:</B><DD>The value returned by the script. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../../../org/apache/sling/api/scripting/ScriptEvaluationException.html" title="class in org.apache.sling.api.scripting">ScriptEvaluationException</A></CODE> - If an error occurrs executing the + script or preparing the script execution. The cause of the + evaluation execption is available as the exception cause.</DL> +</DD> +</DL> +<HR> + +<A NAME="call(org.apache.sling.api.scripting.SlingBindings, java.lang.String, java.lang.Object...)"><!-- --></A><H3> +call</H3> +<PRE> +java.lang.Object <B>call</B>(<A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html" title="class in org.apache.sling.api.scripting">SlingBindings</A> props, + java.lang.String method, + java.lang.Object... args)</PRE> +<DL> +<DD>Evaluates this script using the bound variables as global variables to + the script and then calls the given method with the arguments. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>props</CODE> - The <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html" title="class in org.apache.sling.api.scripting"><CODE>SlingBindings</CODE></A> providing the bound variables for + evaluating the script. Any bound variables must conform to the + requirements of the <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html" title="class in org.apache.sling.api.scripting"><CODE>SlingBindings</CODE></A> predefined variables + set.<DD><CODE>method</CODE> - The name of the method to call.<DD><CODE>args</CODE> - The arguments for the method call. +<DT><B>Returns:</B><DD>The value returned by the method from the script. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../../../org/apache/sling/api/scripting/ScriptEvaluationException.html" title="class in org.apache.sling.api.scripting">ScriptEvaluationException</A></CODE> - If an error occurrs executing the + script or preparing the script execution. The cause of the + evaluation execption is available as the exception cause.</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SlingScript.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../org/apache/sling/api/scripting/SlingBindings.html" title="class in org.apache.sling.api.scripting"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/sling/api/scripting/SlingScriptHelper.html" title="interface in org.apache.sling.api.scripting"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/sling/api/scripting/SlingScript.html" target="_top"><B>FRAMES</B></A> + <A HREF="SlingScript.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> +Copyright © 2007-2009. All Rights Reserved. +</BODY> +</HTML>