Package org.anchoranalysis.plugin.image.bean.object.provider

Class WithOptionalDimensionsBase

Object

AnchorBean<ObjectCollectionProvider>

InitializableBean<ObjectCollectionProvider,ImageInitialization>

ImageBean<ObjectCollectionProvider>

ObjectCollectionProvider

ObjectCollectionProviderUnary

WithOptionalDimensionsBase

All Implemented Interfaces:

Provider<ObjectCollection>

Direct Known Subclasses:

ObjectCollectionProviderFilterBase, ObjectCollectionProviderMorphological

public abstract class WithOptionalDimensionsBase
extends ObjectCollectionProviderUnary

Base class for ObjectCollectionProviderUnary classes that offer an optional means to specify dimensions.

Author:

Owen Feehan

See Also:

• for a similar class with mandatory dimension specification.

Constructor Summary

Constructors

Constructor	Description
WithOptionalDimensionsBase()

Method Summary

Modifier and Type	Method	Description
protected Optional<Dimensions>	createDims()	Creates the dimensions if a DimensionsProvider is specified.
DimensionsProvider	getDimensions()	Optional provider for dimensions.
void	setDimensions(DimensionsProvider dimensions)	Optional provider for dimensions.

Methods inherited from class org.anchoranalysis.image.bean.provider.ObjectCollectionProviderUnary

createFromObjects, get, getObjects, setObjects

Methods inherited from class org.anchoranalysis.bean.initializable.InitializableBean

getInitialization, getLogger, getPropertyInitializer, initialize, initializeRecursive, initRecursiveWithInitializer, isInitialized, onInitialization

Methods inherited from class org.anchoranalysis.bean.AnchorBean

checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString

Methods inherited from class java.lang.Object

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

Constructor Details

WithOptionalDimensionsBase

public WithOptionalDimensionsBase()

Method Details

createDims

protected Optional<Dimensions> createDims()
                                   throws ProvisionFailedException

Creates the dimensions if a DimensionsProvider is specified.

Returns:

an optional containing the dimensions if provided, or empty if not

Throws:

ProvisionFailedException - if creating the dimensions fails

getDimensions

public DimensionsProvider getDimensions()

Optional provider for dimensions.

setDimensions

public void setDimensions(DimensionsProvider dimensions)

Optional provider for dimensions.