Interface ExternalPatternSink

All Known Subinterfaces:

PatternProvider

@API(status=STABLE,
     since="2.0.0-milestone.4.12")
public interface ExternalPatternSink

Gives the ability to a Task to dump inputs of an external Pattern into the external target.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ExternalPatternSink.Result

Method Summary

Modifier and Type	Method	Description
@Nullable ExternalPatternSinkDetails	getDetails()
ExternalPatternSinkId	getId()	Returns a unique ID for this sink.
ExternalPatternSink.Result	insertAll(Pattern pattern, Collection<ResourceAmount> resources, Action action)	Inserts the given resources into the external target.
default ExternalPatternSinkId	unwrapId(Pattern pattern)	If this sink acts as a proxy for another sink, the ID of the other sink should be returned here.

Method Details

insertAll

ExternalPatternSink.Result insertAll(Pattern pattern,
 Collection<ResourceAmount> resources,
 Action action)

Inserts the given resources into the external target. All resources MUST be able to be inserted for this method to return ExternalPatternSink.Result.ACCEPTED, otherwise, it must return ExternalPatternSink.Result.REJECTED. If the sink is locked, it must return ExternalPatternSink.Result.LOCKED. If the resources are not applicable for this sink, it must return ExternalPatternSink.Result.SKIPPED.

Parameters:

pattern - the pattern

resources - the resources

action - the action

Returns:

the result

getId

ExternalPatternSinkId getId()

Returns a unique ID for this sink. This is used to unlock sinks that became locked after inserting an external iteration. The ID must remain stable across the lifecycle of the ExternalPatternSink.

Returns:

the ID for this sink

unwrapId

default ExternalPatternSinkId unwrapId(Pattern pattern)

If this sink acts as a proxy for another sink, the ID of the other sink should be returned here. This is used so that the correct sink can be notified (and potentially be unlocked) when an external iteration is received.

Returns:

the ID of the sink this sink is proxying for, or the same ID as getId() if it is not a proxy

getDetails

@Nullable ExternalPatternSinkDetails getDetails()

Returns:

optional details that belong to this sink