public abstract class AbstractAssetProvider extends Object implements AssetProvider
implementations
.
Enables configuration of MediaType
s that this provider... provides.AssetProvider.AssetNotFoundException, AssetProvider.IllegalItemKeyException
Constructor and Description |
---|
AbstractAssetProvider() |
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 . |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getAsset, getFolder, getItem, getRootFolder, list, supports
protected abstract EnumSet<AssetProviderCapability> setupProviderCapabilities()
protected EnumSet<AssetProviderCapability> getProviderCapabilities()
public boolean supports(AssetProviderCapability capability)
AssetProvider
AssetProviderCapability
.supports
in interface AssetProvider
public boolean provides(com.google.common.net.MediaType mediaType)
AssetProvider
provides
in interface AssetProvider
public String getIdentifier()
AssetProvider
getIdentifier
in interface AssetProvider
public AssetRenderer getRendererFor(Asset asset, com.google.common.net.MediaType to)
AssetProvider
AssetRenderer
if this provider has specific renderers, or null if there is none.getRendererFor
in interface AssetProvider
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 ?
public List<com.google.common.net.MediaType> getMediaTypes()
public void setMediaTypes(List<com.google.common.net.MediaType> mediaTypes)
public void setIdentifier(String identifier)
public List<AssetRenderer> getRenderers()
public void setRenderers(List<AssetRenderer> renderers)
Copyright © 2020 Magnolia International Ltd.. All rights reserved.