org.apache.beam.sdk.util.common

Class ElementByteSizeObserver

java.lang.Object

org.apache.beam.sdk.util.common.ElementByteSizeObserver

All Implemented Interfaces:

java.util.Observer

Direct Known Subclasses:

CoderProperties.TestElementByteSizeObserver

@Internal
public abstract class ElementByteSizeObserver
extends java.lang.Object
implements java.util.Observer

An observer that gets notified when additional bytes are read and/or used.

Constructor Summary

Constructors

Constructor and Description
ElementByteSizeObserver()

Method Summary

Modifier and Type	Method and Description
void	advance() Advances the observer to the next element.
boolean	getIsLazy() Returns whether byte counting for the current element is lazy, that is, whether the observer gets notified of the element's byte count only as element's pieces are being processed or iterated over.
protected abstract void	reportElementSize(long elementByteSize) Called to report element byte size.
void	setLazy() Sets byte counting for the current element as lazy.
void	setScalingFactor(double scalingFactor) Sets a multiplier to use on observed sizes.
void	update(java.lang.Object obj) Updates the observer with a context specified, but without an instance of the Observable.
void	update(java.util.Observable obs, java.lang.Object obj)

Methods inherited from class java.lang.Object

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

Constructor Detail

ElementByteSizeObserver

public ElementByteSizeObserver()

Method Detail

reportElementSize

protected abstract void reportElementSize(long elementByteSize)

Called to report element byte size.

setLazy

public void setLazy()

Sets byte counting for the current element as lazy. That is, the observer will get notified of the element's byte count only as element's pieces are being processed or iterated over.

getIsLazy

public boolean getIsLazy()

Returns whether byte counting for the current element is lazy, that is, whether the observer gets notified of the element's byte count only as element's pieces are being processed or iterated over.

update

public void update(java.lang.Object obj)

Updates the observer with a context specified, but without an instance of the Observable.

setScalingFactor

public void setScalingFactor(double scalingFactor)

Sets a multiplier to use on observed sizes.

update

public void update(java.util.Observable obs,
                   java.lang.Object obj)

Specified by:

update in interface java.util.Observer

advance

public void advance()

Advances the observer to the next element. Adds the current total byte size to the counter, and prepares the observer for the next element.