io.warp10.script.functions

Class SNAPSHOT

java.lang.Object

io.warp10.script.NamedWarpScriptFunction

io.warp10.script.functions.SNAPSHOT

All Implemented Interfaces:

WarpScriptStackFunction

public class SNAPSHOT
extends NamedWarpScriptFunction
implements WarpScriptStackFunction

Replaces the stack so far with a WarpScript snippet which will regenerate the same stack content. Some elements may fail to be converted correctly (i.e. macros)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SNAPSHOT.Snapshotable
static interface	SNAPSHOT.SnapshotEncoder

Constructor Summary

Constructors

Constructor and Description
SNAPSHOT(java.lang.String name, boolean snapshotSymbols, boolean toMark, boolean pop, boolean countbased)
SNAPSHOT(java.lang.String name, boolean snapshotSymbols, boolean toMark, boolean pop, boolean countbased, boolean compresswrappers)
SNAPSHOT(java.lang.String name, boolean snapshotSymbols, boolean toMark, boolean pop, boolean countbased, boolean compresswrappers, boolean readable)

Method Summary

Modifier and Type	Method and Description
static void	addElement(SNAPSHOT snapshot, java.lang.StringBuilder sb, java.lang.Object o)
static void	addElement(SNAPSHOT snapshot, java.lang.StringBuilder sb, java.lang.Object o, boolean readable)
static void	addElement(java.lang.StringBuilder sb, java.lang.Object o)
static void	addElement(java.lang.StringBuilder sb, java.lang.Object o, boolean readable)
static void	addEncoder(SNAPSHOT.SnapshotEncoder encoder)
static void	appendProcessedString(java.lang.StringBuilder sb, java.lang.String s) Process a string to make it readable and compatible in WarpScript code.
java.lang.Object	apply(WarpScriptStack stack)

Methods inherited from class io.warp10.script.NamedWarpScriptFunction

getName, refSnapshot, setName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SNAPSHOT

public SNAPSHOT(java.lang.String name,
                boolean snapshotSymbols,
                boolean toMark,
                boolean pop,
                boolean countbased)

SNAPSHOT

public SNAPSHOT(java.lang.String name,
                boolean snapshotSymbols,
                boolean toMark,
                boolean pop,
                boolean countbased,
                boolean compresswrappers)

SNAPSHOT

public SNAPSHOT(java.lang.String name,
                boolean snapshotSymbols,
                boolean toMark,
                boolean pop,
                boolean countbased,
                boolean compresswrappers,
                boolean readable)

Method Detail

apply

public java.lang.Object apply(WarpScriptStack stack)
                       throws WarpScriptException

Specified by:

apply in interface WarpScriptStackFunction

Throws:

WarpScriptException

addElement

public static void addElement(java.lang.StringBuilder sb,
                              java.lang.Object o)
                       throws WarpScriptException

Throws:

WarpScriptException

addElement

public static void addElement(java.lang.StringBuilder sb,
                              java.lang.Object o,
                              boolean readable)
                       throws WarpScriptException

Throws:

WarpScriptException

addElement

public static void addElement(SNAPSHOT snapshot,
                              java.lang.StringBuilder sb,
                              java.lang.Object o)
                       throws WarpScriptException

Throws:

WarpScriptException

addElement

public static void addElement(SNAPSHOT snapshot,
                              java.lang.StringBuilder sb,
                              java.lang.Object o,
                              boolean readable)
                       throws WarpScriptException

Throws:

WarpScriptException

appendProcessedString

public static void appendProcessedString(java.lang.StringBuilder sb,
                                         java.lang.String s)

Process a string to make it readable and compatible in WarpScript code.

Parameters:

sb - A StringBuilder whose given String will appended to.

s - A String which may contain invalid WarpScript characters. It will not be encapsulated with quote characters so it should be appended to the StringBuilder before and after. Double quotes will not be escaped, so only single quotes are acceptable.

addEncoder

public static void addEncoder(SNAPSHOT.SnapshotEncoder encoder)