Package io.bdeploy.bhive.op

Class ObjectListOperation

java.lang.Object

io.bdeploy.bhive.BHive.Operation<Set<ObjectId>>

io.bdeploy.bhive.op.ObjectListOperation

All Implemented Interfaces:

BHiveExecution, Callable<Set<ObjectId>>

@ReadOnlyOperation
public class ObjectListOperation
extends BHive.Operation<Set<ObjectId>>

List ObjectIds available in the BHive.

Typically used to retrieve a flattened list of ObjectIds recursively required by one or more Manifests.

If no Manifest or tree is set, an exception is thrown.

Constructor Summary

Constructors

Constructor	Description
ObjectListOperation()

Method Summary

Modifier and Type	Method	Description
ObjectListOperation	addManifest(Manifest.Key manifest)	Restrict ObjectId listing to the given Manifest(s).
ObjectListOperation	addManifest(Collection<Manifest.Key> manifests)	Restrict ObjectId listing to the given Manifest(s).
ObjectListOperation	addTree(ObjectId tree)	Restrict ObjectId listing to the given Tree(s).
ObjectListOperation	addTree(Set<ObjectId> trees)	Restrict ObjectId listing to the given Tree(s).
Set<ObjectId>	call()
ObjectListOperation	excludeTree(ObjectId tree)	When scanning, exclude the given Tree and all of it's children.
ObjectListOperation	excludeTree(Set<ObjectId> trees)	When scanning, exclude the given Tree and all of it's children.
ObjectListOperation	ignoreMissingManifest(boolean ignore)	Whether to ignore if a manifest is no longer present for listing.

Methods inherited from class io.bdeploy.bhive.BHive.Operation

execute, getActivityReporter, getAuditor, getLockContentSupplier, getLockContentValidator, getManifestDatabase, getMarkerRoot, getObjectManager, getTransactions, setRetryCount, submitFileOperation

Methods inherited from class java.lang.Object

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

Constructor Details

ObjectListOperation

public ObjectListOperation()

Method Details

call

public Set<ObjectId> call()
                   throws Exception

Throws:

Exception

addManifest

public ObjectListOperation addManifest(Collection<Manifest.Key> manifests)

Restrict ObjectId listing to the given Manifest(s).

addTree

public ObjectListOperation addTree(Set<ObjectId> trees)

Restrict ObjectId listing to the given Tree(s).

excludeTree

public ObjectListOperation excludeTree(Set<ObjectId> trees)

When scanning, exclude the given Tree and all of it's children.

addManifest

public ObjectListOperation addManifest(Manifest.Key manifest)

Restrict ObjectId listing to the given Manifest(s).

addTree

public ObjectListOperation addTree(ObjectId tree)

Restrict ObjectId listing to the given Tree(s).

excludeTree

public ObjectListOperation excludeTree(ObjectId tree)

When scanning, exclude the given Tree and all of it's children.

ignoreMissingManifest

public ObjectListOperation ignoreMissingManifest(boolean ignore)

Whether to ignore if a manifest is no longer present for listing.

Only if the manifest is not there anymore this fact will be ignored. If the manifest cannot be loaded for another reason, this still throws an Exception.