org.directwebremoting.ScriptBuffer Maven / Gradle / Ivy
Show all versions of dwr Show documentation
/*
* Copyright 2005 Joe Walker
*
* Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.directwebremoting;
import java.util.ArrayList;
import java.util.List;
import org.directwebremoting.io.StringWrapper;
import org.directwebremoting.proxy.ScriptProxy;
/**
* A ScriptBuffer is like a StringBuffer except that it is used to create
* Javascript commands. There are 2 version of the append() method:
* The first is {@link #appendScript(String)} which assumes that the
* parameter is to be inserted literally into the output.
*
The second is {@link #appendData(String)} (and variants for Object and
* primitive types) which assumes that the parameter is a variable which should
* be properly converted, escaped and quoted.
* @author Joe Walker [joe at getahead dot ltd dot uk]
*/
public class ScriptBuffer
{
/**
* Create an empty ScriptBuffer.
*/
public ScriptBuffer()
{
}
/**
* Create a ScriptBuffer with some initial content.
* {@link #appendScript(String)} is called with the passed string
* @param str The initial string to place in the buffer
*/
public ScriptBuffer(String str)
{
appendScript(str);
}
/**
* @param buffer The ScriptBuffer to merge into this script
* @return this. To allow buffer.append(x).append(y).append(z);
* @see java.lang.StringBuffer#append(java.lang.String)
*/
public ScriptBuffer appendAll(ScriptBuffer buffer)
{
for (Object part : buffer.parts)
{
parts.add(part);
}
return this;
}
/**
* @param str The String to add to the script
* @return this. To allow buffer.append(x).append(y).append(z);
* @see java.lang.StringBuffer#append(java.lang.String)
*/
public ScriptBuffer appendScript(String str)
{
parts.add(new StringWrapper(str));
return this;
}
/**
* @param b The boolean to add to the script
* @return this. To allow buffer.append(x).append(y).append(z);
* @see java.lang.StringBuffer#append(boolean)
*/
public ScriptBuffer appendData(boolean b)
{
Boolean data = b ? Boolean.TRUE : Boolean.FALSE;
parts.add(data);
return this;
}
/**
* @param c The char to add to the script
* @return this. To allow buffer.append(x).append(y).append(z);
* @see java.lang.StringBuffer#append(char)
*/
public ScriptBuffer appendData(char c)
{
parts.add(c);
return this;
}
/**
* @param d The double to add to the script
* @return this. To allow buffer.append(x).append(y).append(z);
* @see java.lang.StringBuffer#append(double)
*/
public ScriptBuffer appendData(double d)
{
parts.add(d);
return this;
}
/**
* @param f The float to add to the script
* @return this. To allow buffer.append(x).append(y).append(z);
* @see java.lang.StringBuffer#append(float)
*/
public ScriptBuffer appendData(float f)
{
parts.add(f);
return this;
}
/**
* @param i The int to add to the script
* @return this. To allow buffer.append(x).append(y).append(z);
* @see java.lang.StringBuffer#append(int)
*/
public ScriptBuffer appendData(int i)
{
parts.add(i);
return this;
}
/**
* @param l The long to add to the script
* @return this. To allow buffer.append(x).append(y).append(z);
* @see java.lang.StringBuffer#append(long)
*/
public ScriptBuffer appendData(long l)
{
parts.add(l);
return this;
}
/**
* @param obj The Object to add to the script
* @return this. To allow buffer.append(x).append(y).append(z);
* @see java.lang.StringBuffer#append(java.lang.Object)
*/
public ScriptBuffer appendData(Object obj)
{
parts.add(obj);
return this;
}
/**
* @param str The String to add to the script
* @return this. To allow buffer.append(x).append(y).append(z);
* @see java.lang.StringBuffer#append(java.lang.String)
*/
public ScriptBuffer appendData(String str)
{
parts.add(str);
return this;
}
/**
* Call a named function with no parameters.
* @param funcName The name of the function to call
* @return this. To allow buffer.append(x).append(y).append(z);
* @see ScriptProxy#addFunctionCall(String)
*/
public ScriptBuffer appendCall(String funcName)
{
appendScript(funcName);
appendScript("();");
return this;
}
/**
* Call a named function with one parameter.
* @param funcName The name of the function to call
* @param param1 The first parameter to the above function
* @return this. To allow buffer.append(x).append(y).append(z);
* @see ScriptProxy#addFunctionCall(String, Object)
*/
public ScriptBuffer appendCall(String funcName, Object param1)
{
appendScript(funcName);
appendScript("(");
appendData(param1);
appendScript(");");
return this;
}
/**
* Call a named function with one parameter.
* @param funcName The name of the function to call
* @param param1 The first parameter to the above function
* @param param2 The second parameter to the above function
* @return this. To allow buffer.append(x).append(y).append(z);
* @see ScriptProxy#addFunctionCall(String, Object, Object)
*/
public ScriptBuffer appendCall(String funcName, Object param1, Object param2)
{
appendScript(funcName);
appendScript("(");
appendData(param1);
appendScript(",");
appendData(param2);
appendScript(");");
return this;
}
/**
* Call a named function with one parameter.
* @param funcName The name of the function to call
* @param param1 The first parameter to the above function
* @param param2 The second parameter to the above function
* @param param3 The third parameter to the above function
* @return this. To allow buffer.append(x).append(y).append(z);
* @see ScriptProxy#addFunctionCall(String, Object, Object, Object)
*/
public ScriptBuffer appendCall(String funcName, Object param1, Object param2, Object param3)
{
appendScript(funcName);
appendScript("(");
appendData(param1);
appendScript(",");
appendData(param2);
appendScript(",");
appendData(param3);
appendScript(");");
return this;
}
/**
* Call a named function with one parameter.
* @param funcName The name of the function to call
* @param param1 The first parameter to the above function
* @param param2 The second parameter to the above function
* @param param3 The third parameter to the above function
* @param param4 The fourth parameter to the above function
* @return this. To allow buffer.append(x).append(y).append(z);
* @see ScriptProxy#addFunctionCall(String, Object, Object, Object, Object)
*/
public ScriptBuffer appendCall(String funcName, Object param1, Object param2, Object param3, Object param4)
{
appendScript(funcName);
appendScript("(");
appendData(param1);
appendScript(",");
appendData(param2);
appendScript(",");
appendData(param3);
appendScript(",");
appendData(param4);
appendScript(");");
return this;
}
/**
* Call a named function with one parameter.
* @param funcName The name of the function to call
* @param param1 The first parameter to the above function
* @param param2 The second parameter to the above function
* @param param3 The third parameter to the above function
* @param param4 The fourth parameter to the above function
* @param param5 The fifth parameter to the above function
* @return this. To allow buffer.append(x).append(y).append(z);
* @see ScriptProxy#addFunctionCall(String, Object, Object, Object, Object, Object)
*/
public ScriptBuffer appendCall(String funcName, Object param1, Object param2, Object param3, Object param4, Object param5)
{
appendScript(funcName);
appendScript("(");
appendData(param1);
appendScript(",");
appendData(param2);
appendScript(",");
appendData(param3);
appendScript(",");
appendData(param4);
appendScript(",");
appendData(param5);
return this;
}
/**
* Call a named function with one parameter.
* @param funcName The name of the function to call
* @param param1 The first parameter to the above function
* @param param2 The second parameter to the above function
* @param param3 The third parameter to the above function
* @param param4 The fourth parameter to the above function
* @param param5 The fifth parameter to the above function
* @param param6 The sixth parameter to the above function
* @return this. To allow buffer.append(x).append(y).append(z);
* @see ScriptProxy#addFunctionCall(String, Object, Object, Object, Object, Object, Object)
*/
public ScriptBuffer appendCall(String funcName, Object param1, Object param2, Object param3, Object param4, Object param5, Object param6)
{
appendScript(funcName);
appendScript("(");
appendData(param1);
appendScript(",");
appendData(param2);
appendScript(",");
appendData(param3);
appendScript(",");
appendData(param4);
appendScript(",");
appendData(param5);
appendScript(",");
appendData(param6);
return this;
}
/**
* Call a named function with one parameter.
* @param funcName The name of the function to call
* @param param1 The first parameter to the above function
* @param param2 The second parameter to the above function
* @param param3 The third parameter to the above function
* @param param4 The fourth parameter to the above function
* @param param5 The fifth parameter to the above function
* @param param6 The sixth parameter to the above function
* @param param7 The seventh parameter to the above function
* @return this. To allow buffer.append(x).append(y).append(z);
* @see ScriptProxy#addFunctionCall(String, Object, Object, Object, Object, Object, Object, Object)
*/
public ScriptBuffer appendCall(String funcName, Object param1, Object param2, Object param3, Object param4, Object param5, Object param6, Object param7)
{
appendScript(funcName);
appendScript("(");
appendData(param1);
appendScript(",");
appendData(param2);
appendScript(",");
appendData(param3);
appendScript(",");
appendData(param4);
appendScript(",");
appendData(param5);
appendScript(",");
appendData(param6);
appendScript(",");
appendData(param7);
return this;
}
/**
* Call a named function with one parameter.
* @param funcName The name of the function to call
* @param param1 The first parameter to the above function
* @param param2 The second parameter to the above function
* @param param3 The third parameter to the above function
* @param param4 The fourth parameter to the above function
* @param param5 The fifth parameter to the above function
* @param param6 The sixth parameter to the above function
* @param param7 The seventh parameter to the above function
* @param param8 The eighth parameter to the above function
* @return this. To allow buffer.append(x).append(y).append(z);
* @see ScriptProxy#addFunctionCall(String, Object, Object, Object, Object, Object, Object, Object)
*/
public ScriptBuffer appendCall(String funcName, Object param1, Object param2, Object param3, Object param4, Object param5, Object param6, Object param7, Object param8)
{
appendScript(funcName);
appendScript("(");
appendData(param1);
appendScript(",");
appendData(param2);
appendScript(",");
appendData(param3);
appendScript(",");
appendData(param4);
appendScript(",");
appendData(param5);
appendScript(",");
appendData(param6);
appendScript(",");
appendData(param7);
appendScript(",");
appendData(param8);
return this;
}
/**
* Call a named function with one parameter.
* @param funcName The name of the function to call
* @param param1 The first parameter to the above function
* @param param2 The second parameter to the above function
* @param param3 The third parameter to the above function
* @param param4 The fourth parameter to the above function
* @param param5 The fifth parameter to the above function
* @param param6 The sixth parameter to the above function
* @param param7 The seventh parameter to the above function
* @param param8 The eighth parameter to the above function
* @param param9 The ninth parameter to the above function
* @return this. To allow buffer.append(x).append(y).append(z);
* @see ScriptProxy#addFunctionCall(String, Object, Object, Object, Object, Object, Object, Object)
*/
public ScriptBuffer appendCall(String funcName, Object param1, Object param2, Object param3, Object param4, Object param5, Object param6, Object param7, Object param8, Object param9)
{
appendScript(funcName);
appendScript("(");
appendData(param1);
appendScript(",");
appendData(param2);
appendScript(",");
appendData(param3);
appendScript(",");
appendData(param4);
appendScript(",");
appendData(param5);
appendScript(",");
appendData(param6);
appendScript(",");
appendData(param7);
appendScript(",");
appendData(param8);
appendScript(",");
appendData(param9);
return this;
}
/**
* Call a named function with one parameter.
* @param funcName The name of the function to call
* @param param1 The first parameter to the above function
* @param param2 The second parameter to the above function
* @param param3 The third parameter to the above function
* @param param4 The fourth parameter to the above function
* @param param5 The fifth parameter to the above function
* @param param6 The sixth parameter to the above function
* @param param7 The seventh parameter to the above function
* @param param8 The eighth parameter to the above function
* @param param9 The ninth parameter to the above function
* @param param10 The tenth parameter to the above function
* @return this. To allow buffer.append(x).append(y).append(z);
* @see ScriptProxy#addFunctionCall(String, Object, Object, Object, Object, Object, Object, Object)
*/
public ScriptBuffer appendCall(String funcName, Object param1, Object param2, Object param3, Object param4, Object param5, Object param6, Object param7, Object param8, Object param9, Object param10)
{
appendScript(funcName);
appendScript("(");
appendData(param1);
appendScript(",");
appendData(param2);
appendScript(",");
appendData(param3);
appendScript(",");
appendData(param4);
appendScript(",");
appendData(param5);
appendScript(",");
appendData(param6);
appendScript(",");
appendData(param7);
appendScript(",");
appendData(param8);
appendScript(",");
appendData(param9);
appendScript(",");
appendData(param10);
return this;
}
/* (non-Javadoc)
* @see java.lang.Object#toString()
*/
@Override
public String toString()
{
return parts.toString();
}
/**
* For DWR use only - This method is not part of the public API.
* Do not use it without understanding the implications for future proofing.
* @return The list of parts of the final output script
*/
public List getParts()
{
return parts;
}
/**
* This is where we store all the script components waiting to be serialized
*/
private final List