Class SortedJobs

java.lang.Object

ch.tocco.nice2.outputcenter.api.sorting.SortedBase

ch.tocco.nice2.outputcenter.api.sorting.SortedJobs

All Implemented Interfaces:

Iterable<OutputCenterInputSupplier>

public final class SortedJobs
extends SortedBase
implements Iterable<OutputCenterInputSupplier>

The result when sorting a set of OutputJobs. It iterates over all documents that are sorted according to the specification. Besides that, methods are provided to access certain parts individually. This object is only mutable from classes in this package. Once obtained from the JobItemSorter, it is immutable. All (public) methods return non-null values and take non-null arguments.

Constructor Summary

Constructors

Constructor	Description
SortedJobs()

Method Summary

Modifier and Type	Method	Description
Envelope	getEnvelope(String recipientAddress)
Envelope	getEnvelope(Optional<String> recipientAddress)	Returns the sorted "envelope" for the given recipient address.
Map<Optional<String>, Envelope>	getEnvelopeMap()
List<Envelope>	getEnvelopes()	Returns the list of envelopes properly ordered.
List<SortableItem>	getItems()	Returns all SortableItems in the defined order.
List<Optional<String>>	getRecipientAdresses()	Returns the sorted list of the *address as string* fields.
Iterator<OutputCenterInputSupplier>	iterator()

Methods inherited from class SortedBase

findSupplier, getOutputJobs, getUnwrapped

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Constructor Details

SortedJobs

public SortedJobs()

Method Details

getRecipientAdresses

public List<Optional<String>> getRecipientAdresses()

Returns the sorted list of the *address as string* fields.

getEnvelope

public Envelope getEnvelope(Optional<String> recipientAddress)

Returns the sorted "envelope" for the given recipient address.

getEnvelope

public Envelope getEnvelope(String recipientAddress)

getEnvelopes

public List<Envelope> getEnvelopes()

Returns the list of envelopes properly ordered.

getItems

public List<SortableItem> getItems()

Returns all SortableItems in the defined order. The SortableItem can be used to extract the user-defined objects.

Specified by:

getItems in class SortedBase

getEnvelopeMap

public Map<Optional<String>, Envelope> getEnvelopeMap()

iterator

public Iterator<OutputCenterInputSupplier> iterator()

Specified by:

iterator in interface Iterable<OutputCenterInputSupplier>