@ConsumerType
public interface DistributionQueue
DistributionQueueItem
queue items in a sequential queue.Modifier and Type | Method and Description |
---|---|
@Nullable DistributionQueueEntry |
add(@NotNull DistributionQueueItem item)
add a distribution item to this queue
|
@NotNull Iterable<DistributionQueueEntry> |
clear(int limit)
Clear a range of entries from the queue.
|
@NotNull Iterable<DistributionQueueEntry> |
getEntries(int skip,
int limit)
get all the entries in the queue
|
@Nullable DistributionQueueEntry |
getEntry(@NotNull String entryId)
gets an entry from the queue by specifying its id
|
@Nullable DistributionQueueEntry |
getHead()
get the first entry (in a FIFO strategy, the next to be processed) from the queue
|
@NotNull String |
getName()
get this queue name
|
@NotNull DistributionQueueStatus |
getStatus()
get the status of the queue
|
@NotNull DistributionQueueType |
getType()
get the type of this queue
|
boolean |
hasCapability(@NotNull String capability) |
@NotNull Iterable<DistributionQueueEntry> |
remove(@NotNull Set<String> entryIds)
Remove a set entries from the queue by specifying their identifiers.
|
@Nullable DistributionQueueEntry |
remove(@NotNull String entryId)
remove an entry from the queue by specifying its id
|
@NotNull @NotNull String getName()
@Nullable @Nullable DistributionQueueEntry add(@NotNull @NotNull DistributionQueueItem item)
item
- a distribution item, typically representing a DistributionPackage
to distributenoll
if none is created@Nullable @Nullable DistributionQueueEntry getHead()
null
if the queue is empty@NotNull @NotNull Iterable<DistributionQueueEntry> getEntries(int skip, int limit)
skip
- the number of entries to skiplimit
- the maximum number of entries to return. use -1 to return all entries.Iterable
of DistributionQueueEntry
entries@Nullable @Nullable DistributionQueueEntry getEntry(@NotNull @NotNull String entryId)
entryId
- the entry identifiernull
if the entry with the given id
doesn't exist@Nullable @Nullable DistributionQueueEntry remove(@NotNull @NotNull String entryId)
entryId
- the entry identifiernull
if the entry with the given id
doesn't exist@NotNull @NotNull Iterable<DistributionQueueEntry> remove(@NotNull @NotNull Set<String> entryIds)
entryIds
- The identifiers of the entries to be removed@NotNull @NotNull Iterable<DistributionQueueEntry> clear(int limit)
limit
- The maximum number of entries to remove. All entries
are removed when the limit is -1
.@NotNull @NotNull DistributionQueueStatus getStatus()
@NotNull @NotNull DistributionQueueType getType()
boolean hasCapability(@NotNull @NotNull String capability)
true
if the queue supports the capability ;
false
otherwiseCopyright © 2010 - 2020 Adobe. All Rights Reserved