com.netflix.hollow.api.producer

Interface HollowProducer.WriteState

All Superinterfaces:

java.lang.AutoCloseable

Enclosing class:

HollowProducer

public static interface HollowProducer.WriteState
extends java.lang.AutoCloseable

Method Summary

Modifier and Type	Method and Description
int	add(java.lang.Object o) Adds the specified POJO to the state engine.
void	close() Closes this write state making it inoperable.
HollowObjectMapper	getObjectMapper() For advanced use-cases, access the underlying HollowObjectMapper.
HollowProducer.ReadState	getPriorState() For advanced use-cases, access the ReadState of the prior successful cycle.
HollowWriteStateEngine	getStateEngine() For advanced use-cases, access the underlying HollowWriteStateEngine.
long	getVersion() Returns the version of the current producer cycle being populated.

Method Detail

add

int add(java.lang.Object o)
 throws java.lang.IllegalStateException

Adds the specified POJO to the state engine. See HollowObjectMapper.add(Object) for details.

Calling this method after the producer's populate stage has completed is an error.

Parameters:

o - the POJO to add

Returns:

the ordinal associated with the added POJO

Throws:

java.lang.IllegalStateException - if called after the populate stage has completed (see HollowProducer.Populator for details on the contract)

getObjectMapper

HollowObjectMapper getObjectMapper()
                            throws java.lang.IllegalStateException

For advanced use-cases, access the underlying HollowObjectMapper. Prefer using add(Object) on this class instead.

Calling this method after the producer's populate stage has completed is an error. Exercise caution when saving the returned reference in a local variable that is closed over by an asynchronous task as that circumvents this guard. It is safest to call writeState.getObjectMapper() within the closure.

Returns:

the object mapper

Throws:

java.lang.IllegalStateException - if called after the populate stage has completed (see HollowProducer.Populator for details on the contract)

getStateEngine

HollowWriteStateEngine getStateEngine()
                               throws java.lang.IllegalStateException

For advanced use-cases, access the underlying HollowWriteStateEngine. Prefer using add(Object) on this class instead.

Calling this method after the producer's populate stage has completed is an error. Exercise caution when saving the returned reference in a local variable that is closed over by an asynchronous task as that circumvents this guard. It is safest to call writeState.getStateEngine() within the closure.

Returns:

the write state engine

Throws:

java.lang.IllegalStateException - if called after the populate stage has completed (see HollowProducer.Populator for details on the contract)

getPriorState

HollowProducer.ReadState getPriorState()
                                throws java.lang.IllegalStateException

For advanced use-cases, access the ReadState of the prior successful cycle.

Calling this method after the producer's populate stage has completed is an error. Exercise caution when saving the returned reference in a local variable that is closed over by an asynchronous task as that circumvents this guard. It is safest to call writeState.getPriorState() within the closure.

Returns:

the prior read state

Throws:

java.lang.IllegalStateException - if called after the populate stage has completed (see HollowProducer.Populator for details on the contract)

getVersion

long getVersion()
         throws java.lang.IllegalStateException

Returns the version of the current producer cycle being populated.

Calling this method after the producer's populate stage has completed is an error.

Returns:

the version of the current producer cycle

Throws:

java.lang.IllegalStateException - if called after the populate stage has completed (see HollowProducer.Populator for details on the contract)

close

void close()

Closes this write state making it inoperable.

Once closed, calling any other method (aside from close() will throw IllegalStateException. The producer closes the current cycle's write state after the populate stage is complete.

Specified by:

close in interface java.lang.AutoCloseable