Package com.linkedin.venice.pubsub.adapter.kafka.common

Class ApacheKafkaOffsetPosition

java.lang.Object

com.linkedin.venice.pubsub.adapter.kafka.common.ApacheKafkaOffsetPosition

All Implemented Interfaces:

Measurable, PubSubPosition

public class ApacheKafkaOffsetPosition
extends Object
implements PubSubPosition

Offset position for Apache Kafka topics

Constructor Summary

Constructors

Constructor	Description
ApacheKafkaOffsetPosition(long offset)
ApacheKafkaOffsetPosition(ByteBuffer buffer)

Method Summary

Modifier and Type	Method	Description
int	comparePosition(PubSubPosition other)
long	diff(PubSubPosition other)
boolean	equals(Object other)
int	getHeapSize()
long	getNumericOffset()
long	getOffset()
PubSubPositionWireFormat	getPositionWireFormat()	Returns an Avro-encoded wire format representation of this position, including both the position type ID and the raw Avro-encoded bytes representing the position value.
int	hashCode()
static ApacheKafkaOffsetPosition	of(long offset)
static ApacheKafkaOffsetPosition	of(ByteBuffer buffer)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ApacheKafkaOffsetPosition

public ApacheKafkaOffsetPosition(long offset)

ApacheKafkaOffsetPosition

public ApacheKafkaOffsetPosition(ByteBuffer buffer)
                          throws IOException

Parameters:

buffer - the buffer to read from. The ByteBuffer expected to contain avro serialized long

Throws:

IOException - if the buffer is not a valid avro serialized long

Method Details

comparePosition

public int comparePosition(PubSubPosition other)

Specified by:

comparePosition in interface PubSubPosition

Parameters:

other - the other position to compare to

Returns:

returns 0 if the positions are equal, -1 if this position is less than the other position, and 1 if this position is greater than the other position

diff

public long diff(PubSubPosition other)

Specified by:

diff in interface PubSubPosition

Returns:

the difference between this position and the other position

Throws:

IllegalArgumentException - if position is null or positions are not comparable

getOffset

public long getOffset()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Specified by:

equals in interface PubSubPosition

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface PubSubPosition

Overrides:

hashCode in class Object

getNumericOffset

public long getNumericOffset()

Specified by:

getNumericOffset in interface PubSubPosition

of

public static ApacheKafkaOffsetPosition of(long offset)

of

public static ApacheKafkaOffsetPosition of(ByteBuffer buffer)
                                    throws IOException

Throws:

IOException

getPositionWireFormat

public PubSubPositionWireFormat getPositionWireFormat()

Returns an Avro-encoded wire format representation of this position, including both the position type ID and the raw Avro-encoded bytes representing the position value. This is used to transmit PubSubPosition instances over the wire.

Example (ApacheKafkaOffsetPosition):

 +-------------------------+
 | Avro-encoded int: type  |  (e.g., 0)
 +-------------------------+
 | Avro-encoded bytes:     |  (Avro-encoded long offset)
 |   rawBytes              |
 +-------------------------+
 

Specified by:

getPositionWireFormat in interface PubSubPosition

Returns:

the serialized PubSubPositionWireFormat containing the type and position bytes

getHeapSize

public int getHeapSize()

Specified by:

getHeapSize in interface Measurable