org.easybatch.core.record

Class PoisonRecord

java.lang.Object

org.easybatch.core.record.PoisonRecord

All Implemented Interfaces:

Serializable, Record<Object>

public class PoisonRecord
extends Object
implements Record<Object>, Serializable

A marker record that serves as End-Of-Stream record or Poison Record. This is useful to mark the end of reading in a queue based record pulling system.

Author:

Mahmoud Ben Hassine (mahmoud@benhassine.fr)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PoisonRecord()

Method Summary

Methods

Modifier and Type	Method and Description
Header	getHeader() Return the record's header.
Object	getPayload() Return the record's payload.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PoisonRecord

public PoisonRecord()

Method Detail

getHeader

public Header getHeader()

Description copied from interface: Record

Return the record's header.

Specified by:

getHeader in interface Record<Object>

Returns:

the record's header.

getPayload

public Object getPayload()

Description copied from interface: Record

Return the record's payload.

Specified by:

getPayload in interface Record<Object>

Returns:

the record's payload.

toString

public String toString()

Overrides:

toString in class Object