com.yahoo.bullet.result

Class Clip

java.lang.Object

com.yahoo.bullet.result.Clip

All Implemented Interfaces:

JSONFormatter

public class Clip
extends Object
implements JSONFormatter

Field Summary

Fields

Modifier and Type	Field and Description
static String	META_KEY
static String	RECORDS_KEY

Fields inherited from interface com.yahoo.bullet.result.JSONFormatter

GSON, INVALID_DOUBLES

Constructor Summary

Constructors

Constructor and Description
Clip()

Method Summary

Modifier and Type	Method and Description
Clip	add(com.yahoo.bullet.record.BulletRecord record) Adds a BulletRecord to the records in the Clip.
Clip	add(Clip clip) Adds all the BulletRecord and the Meta from the given Clip to this.
Clip	add(List<com.yahoo.bullet.record.BulletRecord> records) Adds all the BulletRecord to the records in the Clip.
Clip	add(Meta meta) Tags additional metadata.
String	asJSON() Convert this object to a JSON string.
static Clip	of(com.yahoo.bullet.record.BulletRecord record) Construct a Clip with the given BulletRecord.
static Clip	of(List<com.yahoo.bullet.record.BulletRecord> records) Construct a Clip with the given List of BulletRecord.
static Clip	of(Meta meta) Construct a Clip with the given metadata.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yahoo.bullet.result.JSONFormatter

asJSON, fromJSON

Field Detail

META_KEY

public static final String META_KEY

See Also:

Constant Field Values

RECORDS_KEY

public static final String RECORDS_KEY

See Also:

Constant Field Values

Constructor Detail

Clip

public Clip()

Method Detail

add

public Clip add(com.yahoo.bullet.record.BulletRecord record)

Adds a BulletRecord to the records in the Clip.

Parameters:

record - The input record.

Returns:

This Clip for chaining.

add

public Clip add(List<com.yahoo.bullet.record.BulletRecord> records)

Adds all the BulletRecord to the records in the Clip.

Parameters:

records - The input records.

Returns:

This Clip for chaining.

add

public Clip add(Clip clip)

Adds all the BulletRecord and the Meta from the given Clip to this.

Parameters:

clip - The clip to add.

Returns:

This Clip for chaining.

add

public Clip add(Meta meta)

Tags additional metadata. Merges any new metadata with existing metadata, if present.

Parameters:

meta - Any Meta to add to the Clip. The objects in the Meta must be serializable to JSON with Gson.

Returns:

This Clip for chaining

asJSON

public String asJSON()

Description copied from interface: JSONFormatter

Convert this object to a JSON string.

Specified by:

asJSON in interface JSONFormatter

Returns:

The JSON representation of this.

of

public static Clip of(com.yahoo.bullet.record.BulletRecord record)

Construct a Clip with the given BulletRecord.

Parameters:

record - The input record.

Returns:

The created Clip.

of

public static Clip of(List<com.yahoo.bullet.record.BulletRecord> records)

Construct a Clip with the given List of BulletRecord.

Parameters:

records - The input records.

Returns:

The created Clip.

of

public static Clip of(Meta meta)

Construct a Clip with the given metadata.

Parameters:

meta - The Meta to add. The objects in the Meta must be serializable to JSON with Gson.

Returns:

This object for chaining