anvil
Class Product

java.lang.Object
  |
  +--anvil.Product

public class Product

extends java.lang.Object

Product is a product of data and logic. Data is given by the user (for instance setting global variables) and logic is taken from the script the document is using.

Constructor Summary

Product(Address address, Module script)
Constructs new Product.

Product(Address address, java.io.OutputStream output, Citizen citizen, Module script)
Constructs new Product.

Product(Address address, java.io.OutputStream output, Module script)
Constructs new Product.

Method Summary

void	destroy() Destroys this product and context associated with it.
Any	forge(java.lang.String function) Calls given function.
Any	forge(java.lang.String function, Any[] parameters)
Any	forge(java.lang.String function, java.lang.Object p0)
Any	forge(java.lang.String function, java.lang.Object p0, java.lang.Object p1)
Any	forge(java.lang.String function, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2)
Any	forge(java.lang.String function, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3)
Any	forge(java.lang.String function, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4)
Any	getGlobal(java.lang.String name) Gets a variable from global namespace.
Namespace	getGlobalNamespace() Returns the global namespace used.
Module	getModule() Returns the script being used by this document.
Any	setGlobal(java.lang.String name, Any value) Sets a variable to global namespace.
Any	setGlobal(java.lang.String name, boolean value) Sets a variable to global namespace.
Any	setGlobal(java.lang.String name, double value) Sets a variable to global namespace.
Any	setGlobal(java.lang.String name, int value) Sets a variable to global namespace.
Any	setGlobal(java.lang.String name, java.lang.Object value) Sets a variable to global namespace.
Any	setGlobal(java.lang.String name, java.lang.String value) Sets a variable to global namespace.
void	setLanguage(java.lang.String language)
void	setOutputStream(java.io.OutputStream output) Sets the output stream to write to.

Methods inherited from class java.lang.Object

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

Constructor Detail

Product

public Product(Address address,
               java.io.OutputStream output,
               Citizen citizen,
               Module script)

Constructs new Product.

Parameters:

script - Module

Product

public Product(Address address,
               java.io.OutputStream output,
               Module script)

Constructs new Product.

Parameters:

script - Module

Product

public Product(Address address,
               Module script)

Constructs new Product.

Parameters:

script - Module

Method Detail

destroy

public void destroy()

Destroys this product and context associated with it.

setOutputStream

public void setOutputStream(java.io.OutputStream output)

Sets the output stream to write to.

Parameters:

output - Output stream

getModule

public Module getModule()

Returns the script being used by this document.

Returns:

Module

getGlobalNamespace

public Namespace getGlobalNamespace()

Returns the global namespace used.

Returns:

Namespace

getGlobal

public Any getGlobal(java.lang.String name)

Gets a variable from global namespace.

Parameters:

name - Name of variable

Returns:

Any, or null if it wasn't found

setGlobal

public Any setGlobal(java.lang.String name,
                     boolean value)

Sets a variable to global namespace.

Parameters:

name - Name of variable

value - Value

Returns:

Instance of Any to where the value was wrapped.

setGlobal

public Any setGlobal(java.lang.String name,
                     int value)

Sets a variable to global namespace.

Parameters:

name - Name of variable

value - Value

Returns:

Instance of Any to where the value was wrapped.

setGlobal

public Any setGlobal(java.lang.String name,
                     double value)

Sets a variable to global namespace.

Parameters:

name - Name of variable

value - Value

Returns:

Instance of Any to where the value was wrapped.

setGlobal

public Any setGlobal(java.lang.String name,
                     java.lang.String value)

Sets a variable to global namespace.

Parameters:

name - Name of variable

value - Value

Returns:

Instance of Any to where the value was wrapped.

setGlobal

public Any setGlobal(java.lang.String name,
                     Any value)

Sets a variable to global namespace.

Parameters:

name - Name of variable

value - Value

Returns:

Instance of Any to where the value was wrapped.

setGlobal

public Any setGlobal(java.lang.String name,
                     java.lang.Object value)

Sets a variable to global namespace.

Parameters:

name - Name of variable

value - Value

Returns:

Instance of Any to where the value was wrapped.

setLanguage

public void setLanguage(java.lang.String language)

forge

public Any forge(java.lang.String function)
          throws ForgingException

Calls given function.

Parameters:

function - Name of function to call

ForgingException

forge

public Any forge(java.lang.String function,
                 java.lang.Object p0)
          throws ForgingException

ForgingException

forge

public Any forge(java.lang.String function,
                 java.lang.Object p0,
                 java.lang.Object p1)
          throws ForgingException

ForgingException

forge

public Any forge(java.lang.String function,
                 java.lang.Object p0,
                 java.lang.Object p1,
                 java.lang.Object p2)
          throws ForgingException

ForgingException

forge

public Any forge(java.lang.String function,
                 java.lang.Object p0,
                 java.lang.Object p1,
                 java.lang.Object p2,
                 java.lang.Object p3)
          throws ForgingException

ForgingException

forge

public Any forge(java.lang.String function,
                 java.lang.Object p0,
                 java.lang.Object p1,
                 java.lang.Object p2,
                 java.lang.Object p3,
                 java.lang.Object p4)
          throws ForgingException

ForgingException

forge

public Any forge(java.lang.String function,
                 Any[] parameters)
          throws ForgingException

ForgingException