info.magnolia.dam.api

Class AbstractAssetProvider

java.lang.Object

info.magnolia.dam.api.AbstractAssetProvider

All Implemented Interfaces:

AssetProvider

public abstract class AbstractAssetProvider
extends Object
implements AssetProvider

Convenient abstract base class for implementations. Enables configuration of MediaTypes that this provider... provides.

Nested Class Summary

Nested classes/interfaces inherited from interface info.magnolia.dam.api.AssetProvider

AssetProvider.AssetNotFoundException, AssetProvider.IllegalItemKeyException

Constructor Summary

Constructors

Constructor and Description
AbstractAssetProvider()

Method Summary

Modifier and Type	Method and Description
String	getIdentifier() Return the AssetProvider identifier.
List<com.google.common.net.MediaType>	getMediaTypes()
protected EnumSet<AssetProviderCapability>	getProviderCapabilities()
AssetRenderer	getRendererFor(Asset asset, com.google.common.net.MediaType to) Returns an appropriate AssetRenderer if this provider has specific renderers, or null if there is none.
List<AssetRenderer>	getRenderers()
boolean	provides(com.google.common.net.MediaType mediaType) Whether this provider provides or allows the given MediaType.
void	setIdentifier(String identifier)
void	setMediaTypes(List<com.google.common.net.MediaType> mediaTypes)
void	setRenderers(List<AssetRenderer> renderers)
protected abstract EnumSet<AssetProviderCapability>	setupProviderCapabilities() Called by constructor, so as to setup the capabilities Set once and only one.
boolean	supports(AssetProviderCapability capability) Returns true if the provider supports the given AssetProviderCapability.

Methods inherited from class java.lang.Object

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

Methods inherited from interface info.magnolia.dam.api.AssetProvider

getAsset, getFolder, getItem, getRootFolder, list, supports

Constructor Detail

AbstractAssetProvider

public AbstractAssetProvider()

Method Detail

setupProviderCapabilities

protected abstract EnumSet<AssetProviderCapability> setupProviderCapabilities()

Called by constructor, so as to setup the capabilities Set once and only one. Implementations can build and return an EnumSet with EnumSet.of(AssetProviderCapability....).

getProviderCapabilities

protected EnumSet<AssetProviderCapability> getProviderCapabilities()

supports

public boolean supports(AssetProviderCapability capability)

Description copied from interface: AssetProvider

Returns true if the provider supports the given AssetProviderCapability.

Specified by:

supports in interface AssetProvider

provides

public boolean provides(com.google.common.net.MediaType mediaType)

Description copied from interface: AssetProvider

Whether this provider provides or allows the given MediaType. Some providers can be configured to only be used for a given set or subset of types.

Specified by:

provides in interface AssetProvider

getIdentifier

public String getIdentifier()

Description copied from interface: AssetProvider

Return the AssetProvider identifier.

Specified by:

getIdentifier in interface AssetProvider

getRendererFor

public AssetRenderer getRendererFor(Asset asset,
                                    com.google.common.net.MediaType to)

Description copied from interface: AssetProvider

Returns an appropriate AssetRenderer if this provider has specific renderers, or null if there is none.

Specified by:

getRendererFor in interface AssetProvider

See Also:

AssetProviderRegistry#getRendererFor(Asset, com.google.common.net.MediaType)}, which is what client code should be using rather than this method here. TODO: overdoing it if we move this to abstract to hide it from client code ?

getMediaTypes

public List<com.google.common.net.MediaType> getMediaTypes()

setMediaTypes

public void setMediaTypes(List<com.google.common.net.MediaType> mediaTypes)

setIdentifier

public void setIdentifier(String identifier)

getRenderers

public List<AssetRenderer> getRenderers()

setRenderers

public void setRenderers(List<AssetRenderer> renderers)