com.canto.cumulus

Class AssetCollection

java.lang.Object

com.canto.cumulus.AssetCollection

All Implemented Interfaces:

java.lang.AutoCloseable, java.lang.Iterable<Asset>

public class AssetCollection
extends java.lang.Object
implements java.lang.Iterable<Asset>, java.lang.AutoCloseable

This class represents an iterable collection of Asset objects. You can use it for example to catalog a list of assets in one call (see ItemCollection.catalogAssets(AssetCollection, String, String, java.util.EnumSet, com.canto.cumulus.events.CatalogingListener)).

Since:

8.0

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this collection and releases all acquired resources.
static AssetCollection	create(Asset... assets) Create a new collection from the given assets.
static AssetCollection	create(java.util.List<Asset> assets) Create a new collection from the given list of assets.
CumulusSession	getCumulusSession() Returns the current CumulusSession object.
java.util.Iterator<Asset>	iterator()

Methods inherited from class java.lang.Object

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

Method Detail

close

public void close()

Closes this collection and releases all acquired resources. This might also render all iterator instances unusable generated by this class.

Specified by:

close in interface java.lang.AutoCloseable

Since:

8.1.2

create

public static AssetCollection create(java.util.List<Asset> assets)

Create a new collection from the given list of assets.

Parameters:

assets - list of assets to put into the new created instance

Returns:

new instance

create

public static AssetCollection create(Asset... assets)

Create a new collection from the given assets.

Parameters:

assets - assets to put into the new created instance

Returns:

new instance

getCumulusSession

public CumulusSession getCumulusSession()

Returns the current CumulusSession object.

Returns:

the current CumulusSession object

iterator

public java.util.Iterator<Asset> iterator()

Specified by:

iterator in interface java.lang.Iterable<Asset>