org.apache.shindig.gadgets.js

Class JsResponseBuilder

java.lang.Object

org.apache.shindig.gadgets.js.JsResponseBuilder

public class JsResponseBuilder
extends Object

A class with methods to create JsResponse objects.

Constructor Summary

Constructors

Constructor and Description
JsResponseBuilder()
JsResponseBuilder(JsResponse response)

Method Summary

Methods

Modifier and Type	Method and Description
JsResponseBuilder	addError(String error) Adds an error to the response
JsResponseBuilder	addErrors(List<String> errs) Adds multiple errors to the response
JsResponseBuilder	appendAllJs(Iterable<JsContent> jsBundle) Helper to append a bunch of JS.
JsResponseBuilder	appendExtern(String extern) Appends a line of extern.
JsResponseBuilder	appendExterns(List<String> externs) Appends externs as from list of strings.
JsResponseBuilder	appendJs(JsContent jsContent) Appends more JS to the response.
JsResponseBuilder	appendJs(String content, String name) Helper to append JS to the response w/ a name.
JsResponseBuilder	appendJs(String content, String name, boolean noCompile) Helper to append JS to the response w/ a name.
JsResponseBuilder	appendRawExtern(String rawExtern) Appends a blob of raw extern.
JsResponse	build() Builds a JsResponse object with the provided data.
JsResponseBuilder	clearExterns() Deletes all externs in the builder.
JsResponseBuilder	clearJs() Deletes all JavaScript code in the builder.
int	getCacheTtlSecs() Returns the cache TTL in seconds for the response.
int	getStatusCode() Returns the HTTP status code.
JsResponseBuilder	insertJsAt(int index, JsContent jsContent) Insert a JS at a specific index.
boolean	isProxyCacheable() Returns whether the response can be cached by intermediary proxies.
JsResponseBuilder	prependJs(JsContent jsContent) Prepend a JS to the response.
JsResponseBuilder	prependJs(String content, String name) Prepends JS to the output.
JsResponseBuilder	prependJs(String content, String name, boolean noCompile) Prepends JS to the output.
JsResponseBuilder	setCacheTtlSecs(int cacheTtlSecs) Sets the cache TTL in seconds for the response being built.
JsResponseBuilder	setProxyCacheable(boolean proxyCacheable) Sets whether the response can be cached by intermediary proxies.
JsResponseBuilder	setStatusCode(int responseCode) Sets the HTTP status code.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JsResponseBuilder

public JsResponseBuilder()

JsResponseBuilder

public JsResponseBuilder(JsResponse response)

Method Detail

prependJs

public JsResponseBuilder prependJs(JsContent jsContent)

Prepend a JS to the response.

prependJs

public JsResponseBuilder prependJs(String content,
                          String name)

Prepends JS to the output.

prependJs

public JsResponseBuilder prependJs(String content,
                          String name,
                          boolean noCompile)

Prepends JS to the output.

insertJsAt

public JsResponseBuilder insertJsAt(int index,
                           JsContent jsContent)

Insert a JS at a specific index.

appendJs

public JsResponseBuilder appendJs(JsContent jsContent)

Appends more JS to the response.

appendJs

public JsResponseBuilder appendJs(String content,
                         String name)

Helper to append JS to the response w/ a name.

appendJs

public JsResponseBuilder appendJs(String content,
                         String name,
                         boolean noCompile)

Helper to append JS to the response w/ a name.

appendAllJs

public JsResponseBuilder appendAllJs(Iterable<JsContent> jsBundle)

Helper to append a bunch of JS.

clearJs

public JsResponseBuilder clearJs()

Deletes all JavaScript code in the builder.

setStatusCode

public JsResponseBuilder setStatusCode(int responseCode)

Sets the HTTP status code.

getStatusCode

public int getStatusCode()

Returns the HTTP status code.

addError

public JsResponseBuilder addError(String error)

Adds an error to the response

addErrors

public JsResponseBuilder addErrors(List<String> errs)

Adds multiple errors to the response

setCacheTtlSecs

public JsResponseBuilder setCacheTtlSecs(int cacheTtlSecs)

Sets the cache TTL in seconds for the response being built. 0 seconds means "no cache"; a value below 0 means "cache forever".

getCacheTtlSecs

public int getCacheTtlSecs()

Returns the cache TTL in seconds for the response.

setProxyCacheable

public JsResponseBuilder setProxyCacheable(boolean proxyCacheable)

Sets whether the response can be cached by intermediary proxies.

isProxyCacheable

public boolean isProxyCacheable()

Returns whether the response can be cached by intermediary proxies.

appendRawExtern

public JsResponseBuilder appendRawExtern(String rawExtern)

Appends a blob of raw extern.

appendExtern

public JsResponseBuilder appendExtern(String extern)

Appends a line of extern.

appendExterns

public JsResponseBuilder appendExterns(List<String> externs)

Appends externs as from list of strings.

clearExterns

public JsResponseBuilder clearExterns()

Deletes all externs in the builder.

build

public JsResponse build()

Builds a JsResponse object with the provided data.