public enum AssetProviderCapability extends Enum<AssetProviderCapability>
AssetProvider
. Clients can ask a provider if they support
a certain feature before attempting to use it; typically, this would enable/disable certain UI features.
In some cases, this will also indicate that client code can cast to a specific interface.
(e.g. PathAwareAssetProvider
for hierarchical
)
If support for write operations is added, this enum will also be extended with new capabilities.Enum Constant and Description |
---|
hierarchical
Some providers might not have a notion of a hierarchical tree of folders and assets.
|
query
Whether this provider supports querying at all.
|
queryByKeyword
Whether this provider supports querying by keyword.
|
queryWithProviderSpecificString
Whether this provider supports queries with an additional provider-specific clauses.
|
rendition
Whether this provider supports generating renditions of assets.
|
Modifier and Type | Method and Description |
---|---|
static AssetProviderCapability |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static AssetProviderCapability[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final AssetProviderCapability hierarchical
PathAwareAssetProvider
public static final AssetProviderCapability query
public static final AssetProviderCapability queryByKeyword
public static final AssetProviderCapability rendition
public static final AssetProviderCapability queryWithProviderSpecificString
AssetQuery.getAdditionalQueryStatement()
public static AssetProviderCapability[] values()
for (AssetProviderCapability c : AssetProviderCapability.values()) System.out.println(c);
public static AssetProviderCapability valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullCopyright © 2014 Magnolia International Ltd.. All rights reserved.