Iced (h2o-core 3.0.0 API)

java.lang.Object
- water.Iced<D>

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Freezable<D>

Direct Known Subclasses:

AST, ASTGroupBy.G, ASTGroupBy.IcedHM, ASTGroupBy.IcedNBHS, AUC2, AUC2.AUCBuilder, Categorical, Chunk, ConfusionMatrix, DException, DMatrix.MatrixMulStats, Env, Exec, Frame.VecSpecifier, FVecParseWriter, GetLogsFromNode, H2OError, H2ONode, HeartBeat, IcedBitSet, IcedDouble, IcedHashMapBase, IcedInt, IcedLong, IcedWrapper, Job.Progress, JobsHandler.Jobs, JProfile, JProfile.ProfileSummary, JStack, JStackCollectorTask.DStackTrace, Key, Keyed, KeySnapshot.KeyInfo, Model.Output, Model.Parameters, ModelBuilder.ValidationMessage, ModelMetrics.MetricBuilder, NetworkTest, NodePersistentStorage.NodePersistentStorageEntry, Parser, ParseSetup, PreviewParseWriter, ProfileCollectorTask.NodeProfile, Schema, Schema.Meta, SchemaMetadata, SchemaMetadata.FieldMetadata, ScoreKeeper, ShutdownHandler.Shutdown, TimelineHandler.Timeline, TwoDimTable, Value, ValueString, VarImp, Vec.VectorGroup, WaterMeterCpuTicks, WaterMeterIo
```
public abstract class Iced<D extends Iced>
extends java.lang.Object
implements Freezable<D>, java.io.Externalizable
```
H2O uses Iced classes as the primary means of moving Java Objects around the cluster.
Auto-serializer base-class using a delegator pattern (the faster option is to byte-code gen directly in all Iced classes, but this requires all Iced classes go through a ClassLoader).
Iced is a marker class, and Freezable is the companion marker interface. Marked classes have 2-byte integer type associated with them, and an auto-genned delegate class created to actually do byte-stream and JSON serialization and deserialization. Byte-stream serialization is extremely dense (includes various compressions), and typically memory-bandwidth bound to generate.
During startup time the Weaver creates a parallel set of classes called (classname)$Icer. These provide bytestream and JSON serializers and deserializers which get called by AutoBuffer.write* and AutoBugger.read*.
To debug the automagic serialization code create a transient field in your Iced class called DEBUG_WEAVER. The generated source code will get written to STDOUT:
transient int DEBUG_WEAVER = 1;

See Also:
Weaver, AutoBuffer, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Iced()

Constructors
Constructor and Description
`Iced()`

Method Summary

Methods
Modifier and Type	Method and Description
`D`	`clone()` Clone, without the annoying exception
`int`	`frozenType()` Returns a small dense integer, which is cluster-wide unique per-class.
`D`	`read_impl(AutoBuffer ab)` Implementation of the `Iced` serialization protocol, only called by auto-genned code.
`D`	`read(AutoBuffer ab)` Standard "read thyself from the AutoBuffer" call, using the fast Iced protocol.
`void`	`readExternal(java.io.ObjectInput ois)`
`D`	`readJSON_impl(AutoBuffer ab)` Implementation of the `Iced` serialization protocol, only called by auto-genned code.
`D`	`readJSON(AutoBuffer ab)` Standard "read thyself from the AutoBuffer" call, using JSON.
`java.lang.String`	`toJsonString()` Helper for folks that want a JSON String for this object.
`AutoBuffer`	`write_impl(AutoBuffer ab)` Implementation of the `Iced` serialization protocol, only called by auto-genned code.
`AutoBuffer`	`write(AutoBuffer ab)` Standard "write thyself into the AutoBuffer" call, using the fast Iced protocol.
`void`	`writeExternal(java.io.ObjectOutput oos)`
`DocGen.HTML`	`writeHTML_impl(DocGen.HTML ab)` Implementation of the `Iced` serialization protocol, only called by auto-genned code.
`DocGen.HTML`	`writeHTML(DocGen.HTML sb)` Standard "write thyself into the AutoBuffer" call, using HTML.
`AutoBuffer`	`writeJSON_impl(AutoBuffer ab)` Implementation of the `Iced` serialization protocol, only called by auto-genned code.
`AutoBuffer`	`writeJSON(AutoBuffer ab)` Standard "write thyself into the AutoBuffer" call, using JSON.

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

- Constructor Detail
  - Iced
```
public Iced()
```
- Method Detail
  - write
```
public final AutoBuffer write(AutoBuffer ab)
```
    Standard "write thyself into the AutoBuffer" call, using the fast Iced protocol. Real work is in the delegate Icer classes.
    
    Specified by:
    
    write in interface Freezable<D extends Iced>
    
    Parameters:
    ab - AutoBuffer to write this object to.
    
    Returns:
    Returns the original AutoBuffer for flow-coding.
  - writeJSON
```
public final AutoBuffer writeJSON(AutoBuffer ab)
```
    Standard "write thyself into the AutoBuffer" call, using JSON. Real work is in the delegate Icer classes.
    
    Specified by:
    
    writeJSON in interface Freezable<D extends Iced>
    
    Parameters:
    ab - AutoBuffer to write this object to.
    
    Returns:
    Returns the original AutoBuffer for flow-coding.
  - writeHTML
```
public final DocGen.HTML writeHTML(DocGen.HTML sb)
```
    Standard "write thyself into the AutoBuffer" call, using HTML. Real work is in the delegate Icer classes.
    
    Specified by:
    
    writeHTML in interface Freezable<D extends Iced>
    
    Parameters:
    sb - target to serialize this object in HTML form
    
    Returns:
    Returns the original AutoBuffer for flow-coding.
  - read
```
public final D read(AutoBuffer ab)
```
    Standard "read thyself from the AutoBuffer" call, using the fast Iced protocol. Real work is in the delegate Icer classes.
    
    Specified by:
    
    read in interface Freezable<D extends Iced>
    
    Parameters:
    ab - AutoBuffer to read this object from.
    
    Returns:
    Returns the original AutoBuffer for flow-coding.
  - readJSON
```
public final D readJSON(AutoBuffer ab)
```
    Standard "read thyself from the AutoBuffer" call, using JSON. Real work is in the delegate Icer classes.
    
    Specified by:
    
    readJSON in interface Freezable<D extends Iced>
    
    Parameters:
    ab - AutoBuffer to read this object from.
    
    Returns:
    Returns the original AutoBuffer for flow-coding.
  - toJsonString
```
public final java.lang.String toJsonString()
```
    Helper for folks that want a JSON String for this object.
  - frozenType
```
public final int frozenType()
```
    Returns a small dense integer, which is cluster-wide unique per-class. Useful as an array index.
    
    Specified by:
    
    frozenType in interface Freezable<D extends Iced>
    
    Returns:
    Small integer, unique per-type
  - clone
```
public final D clone()
```
    Clone, without the annoying exception
    
    Specified by:
    
    clone in interface Freezable<D extends Iced>
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    Returns this object cloned.
  - write_impl
```
public AutoBuffer write_impl(AutoBuffer ab)
```
    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<D extends Iced>
    
    Parameters:
    ab - AutoBuffer to write this object to.
    
    Returns:
    Returns the original AutoBuffer for flow-coding.
  - read_impl
```
public D read_impl(AutoBuffer ab)
```
    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<D extends Iced>
    
    Parameters:
    ab - AutoBuffer to read this object from.
    
    Returns:
    Returns a new instance of object reconstructed from AutoBuffer.
  - writeJSON_impl
```
public AutoBuffer writeJSON_impl(AutoBuffer ab)
```
    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:
    
    writeJSON_impl in interface Freezable<D extends Iced>
    
    Parameters:
    ab - AutoBuffer to write this object to.
    
    Returns:
    Returns the original AutoBuffer for flow-coding.
  - readJSON_impl
```
public D readJSON_impl(AutoBuffer ab)
```
    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:
    
    readJSON_impl in interface Freezable<D extends Iced>
    
    Parameters:
    ab - AutoBuffer to read this object from.
    
    Returns:
    Returns an instance of object reconstructed from JSON data.
  - writeHTML_impl
```
public DocGen.HTML writeHTML_impl(DocGen.HTML ab)
```
    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:
    
    writeHTML_impl in interface Freezable<D extends Iced>
    
    Parameters:
    ab - html to write object to.
    
    Returns:
    Returns the instance of HTML object.
  - readExternal
```
public void readExternal(java.io.ObjectInput ois)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
```
    Specified by:
    
    readExternal in interface java.io.Externalizable
    
    Throws:
    
    java.io.IOException
    
    java.lang.ClassNotFoundException
  - writeExternal
```
public void writeExternal(java.io.ObjectOutput oos)
                   throws java.io.IOException
```
    Specified by:
    
    writeExternal in interface java.io.Externalizable
    
    Throws:
    
    java.io.IOException

Class Iced<D extends Iced>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Iced

Method Detail

write

writeJSON

writeHTML

read

readJSON

toJsonString

frozenType

clone

write_impl

read_impl

writeJSON_impl

readJSON_impl

writeHTML_impl

readExternal

writeExternal