Env (h2o-core 3.0.0 API)

java.lang.Object
- water.Iced
- - water.rapids.Env

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Freezable
```
public class Env
extends Iced
```
Execute a set of instructions in the context of an H2O cloud. An Env (environment) object is a classic stack of values used during walking of an AST. While walking the syntax tree new scopes may be encountered, and each new scope will inherit from the caller's scope. All scopes have a common ancestor as the global scope. For efficiency, reference counting is employed to recycle objects already in use rather than creating copies upon copies (a la R). When a Vec is `pushed` on to the stack, its reference count is incremented by 1. When a Vec is `popped` off of the stack, its reference count is decremented by 1. When the reference count is 0, the Env instance will dispose of the object. All objects live and die by the Env's that create them. That means that any object not created by an Env instance shalt not be DKV.removed. Therefore, the Env class is a stack of values + an API for reference counting.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

java.lang.StringBuilder _sb

Fields
Modifier and Type	Field and Description
`java.lang.StringBuilder`	`_sb`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addRef(Frame f)`
`void`	`addRef(water.rapids.ValFrame o)` Reference Counting API
`void`	`addRef(Vec v)`
`void`	`clean()`
`boolean`	`hasLock(Key k)`
`boolean`	`isAry()`
`boolean`	`isEmpty()`
`boolean`	`isFun()`
`boolean`	`isGlobal()`
`boolean`	`isId()`
`boolean`	`isNul()`
`boolean`	`isNum()`
`boolean`	`isSeries()`
`boolean`	`isSpan()`
`boolean`	`isStr()`
`Key`	`lock()`
`void`	`lock(Frame fr)`
`void`	`lock(Key k)`
`void`	`lock(java.lang.String k)`
`void`	`lock(Vec v)`
`water.rapids.Val`	`peek()`
`Frame`	`peekAry()`
`Frame`	`peekAryAt(int i)`
`water.rapids.Val`	`peekAt(int i)`
`double`	`peekDbl()`
`int`	`peekType()`
`int`	`peekTypeAt(int i)`
`water.rapids.Val`	`pop()`
`void`	`pop(int n)`
`AST`	`pop2AST()`
`Frame`	`popAry()`
`double`	`popDbl()`
`void`	`poppush(int n, water.rapids.Val v)`
`water.rapids.ValSeries`	`popSeries()`
`water.rapids.ValSpan`	`popSpan()`
`java.lang.String`	`popStr()`
`void`	`postWrite()`
`void`	`push(water.rapids.Val o)`
`void`	`pushAry(Frame fr)`
`Env`	`read_impl(AutoBuffer ab)` Implementation of the `Iced` serialization protocol, only called by auto-genned code.
`void`	`remove_and_unlock()`
`int`	`sp()` The stack API
`void`	`subRef(Frame f)`
`boolean`	`subRef(Vec v)`
`void`	`toss(water.rapids.ValFrame f)`
`java.lang.String`	`toString()`
`java.lang.String`	`toString(int i)`
`static java.lang.String`	`typeToString(int type)`
`void`	`unlock()`
`AutoBuffer`	`write_impl(AutoBuffer ab)` Implementation of the `Iced` serialization protocol, only called by auto-genned code.

Methods inherited from class water.Iced
clone, frozenType, read, readExternal, readJSON_impl, readJSON, toJsonString, write, writeExternal, writeHTML_impl, writeHTML, writeJSON_impl, writeJSON

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_sb

public final transient java.lang.StringBuilder _sb

Method Detail

write_impl
```
public AutoBuffer write_impl(AutoBuffer ab)
```
Description copied from class: Iced

Implementation of the Iced serialization protocol, only called by auto-genned code. Not intended to be called by user code. Override only for custom Iced serializers.

Specified by:

write_impl in interface Freezable

Overrides:

write_impl in class Iced

Parameters:
ab - AutoBuffer to write this object to.

Returns:
Returns the original AutoBuffer for flow-coding.

read_impl
```
public Env read_impl(AutoBuffer ab)
```
Description copied from class: Iced

Implementation of the Iced serialization protocol, only called by auto-genned code. Not intended to be called by user code. Override only for custom Iced serializers.

Specified by:

read_impl in interface Freezable

Overrides:

read_impl in class Iced

Parameters:
ab - AutoBuffer to read this object from.

Returns:
Returns a new instance of object reconstructed from AutoBuffer.

isGlobal
```
public boolean isGlobal()
```

typeToString

public static java.lang.String typeToString(int type)

sp
```
public int sp()
```
The stack API

push
```
public void push(water.rapids.Val o)
```

pushAry
```
public void pushAry(Frame fr)
```

isEmpty
```
public boolean isEmpty()
```

peek
```
public water.rapids.Val peek()
```

peekAt

public water.rapids.Val peekAt(int i)

peekType
```
public int peekType()
```

peekAryAt
```
public Frame peekAryAt(int i)
```

peekTypeAt
```
public int peekTypeAt(int i)
```

isAry
```
public boolean isAry()
```

isNum
```
public boolean isNum()
```

isStr
```
public boolean isStr()
```

isId
```
public boolean isId()
```

isFun
```
public boolean isFun()
```

isNul
```
public boolean isNul()
```

isSpan
```
public boolean isSpan()
```

isSeries
```
public boolean isSeries()
```

pop
```
public water.rapids.Val pop()
```

pop
```
public void pop(int n)
```

poppush

public void poppush(int n,
           water.rapids.Val v)

popAry
```
public Frame popAry()
```

popDbl
```
public double popDbl()
```

popStr
```
public java.lang.String popStr()
```

popSeries

public water.rapids.ValSeries popSeries()

popSpan
```
public water.rapids.ValSpan popSpan()
```

peekAry
```
public Frame peekAry()
```

peekDbl
```
public double peekDbl()
```

pop2AST
```
public AST pop2AST()
```

toss

public void toss(water.rapids.ValFrame f)

clean
```
public void clean()
```

addRef

public void addRef(water.rapids.ValFrame o)

Reference Counting API

addRef
```
public void addRef(Frame f)
```

addRef
```
public void addRef(Vec v)
```

hasLock
```
public boolean hasLock(Key k)
```

lock
```
public void lock(Key k)
```

lock
```
public void lock(Frame fr)
```

lock
```
public void lock(Vec v)
```

lock
```
public void lock(java.lang.String k)
```

lock
```
public Key lock()
```

subRef
```
public boolean subRef(Vec v)
```

subRef
```
public void subRef(Frame f)
```

postWrite
```
public void postWrite()
```

remove_and_unlock
```
public void remove_and_unlock()
```

unlock
```
public void unlock()
```

toString

public java.lang.String toString(int i)

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

Class Env

Field Summary

Method Summary

Methods inherited from class water.Iced

Methods inherited from class java.lang.Object

Field Detail

_sb

Method Detail

write_impl

read_impl

isGlobal

typeToString

sp

push

pushAry

isEmpty

peek

peekAt

peekType

peekAryAt

peekTypeAt

isAry

isNum

isStr

isId

isFun

isNul

isSpan

isSeries

pop

pop

poppush

popAry

popDbl

popStr

popSeries

popSpan

peekAry

peekDbl

pop2AST

toss

clean

addRef

addRef

addRef

hasLock

lock

lock

lock

lock

lock

subRef

subRef

postWrite

remove_and_unlock

unlock

toString

toString