hep.dataforge.io.envelopes

Interface Envelope

All Superinterfaces:

Metoid

All Known Implementing Classes:

EnvelopeBuilder, FileEnvelope, LazyEnvelope, PlotFrame.PlotFrameEnvelope, SimpleEnvelope

public Envelope
extends Metoid

The message is a pack that can include two principal parts:

• Envelope meta-data
• binary data

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	DATA_LENGTH_KEY
java.lang.String	META_LENGTH_KEY
java.lang.String	META_TYPE_KEY
java.lang.String	TYPE_KEY Property keys

Method Summary

Modifier and Type	Method and Description
Binary	getData() Read data into buffer. This operation could take a lot of time so be careful when performing it synchronously
java.util.Optional<java.lang.String>	getDataType() The type of data encoding
java.lang.String	getDescription() Textual user friendly description
Meta	getMeta() Meta part of the envelope
java.util.Optional<java.time.Instant>	getTime() Time of creation of the envelope
java.util.Optional<java.lang.String>	getType() The purpose of the envelope
boolean	hasData()
boolean	hasMeta()
<T> Data<T>	map() Transform Envelope to Lazy data using given transformation. In case transformation failed an exception will be thrown in call site.

Methods inherited from interface hep.dataforge.meta.Metoid

getMeta

Field Detail

TYPE_KEY

java.lang.String TYPE_KEY

Property keys

META_TYPE_KEY

java.lang.String META_TYPE_KEY

META_LENGTH_KEY

java.lang.String META_LENGTH_KEY

DATA_LENGTH_KEY

java.lang.String DATA_LENGTH_KEY

Method Detail

getMeta

Meta getMeta()

Meta part of the envelope

Returns:

getData

Binary getData()

Read data into buffer. This operation could take a lot of time so be careful when performing it synchronously

Returns:

hasMeta

boolean hasMeta()

hasData

boolean hasData()

getType

java.util.Optional<java.lang.String> getType()

The purpose of the envelope

Returns:

getDataType

java.util.Optional<java.lang.String> getDataType()

The type of data encoding

Returns:

getDescription

java.lang.String getDescription()

Textual user friendly description

Returns:

getTime

java.util.Optional<java.time.Instant> getTime()

Time of creation of the envelope

Returns:

map

<T> Data<T> map()

Transform Envelope to Lazy data using given transformation. In case transformation failed an exception will be thrown in call site.

Returns: