info.magnolia.dam.api

Enum AssetProviderCapability

java.lang.Object

java.lang.Enum<AssetProviderCapability>

info.magnolia.dam.api.AssetProviderCapability

All Implemented Interfaces:

Serializable, Comparable<AssetProviderCapability>

public enum AssetProviderCapability
extends Enum<AssetProviderCapability>

Features optional implemented/provided by 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 Summary

Enum Constants

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.
queryWithPagination Whether this provider supports pagination.
queryWithProviderSpecificString Whether this provider supports queries with an additional provider-specific clauses.
queryWithSorting Whether this provider supports sorting in queries.
rendition Whether this provider supports generating renditions of assets.

Method Summary

Methods

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.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

hierarchical

public static final AssetProviderCapability hierarchical

Some providers might not have a notion of a hierarchical tree of folders and assets. This could be used as an indicator for UIs.

See Also:

PathAwareAssetProvider

rendition

public static final AssetProviderCapability rendition

Whether this provider supports generating renditions of assets.

query

public static final AssetProviderCapability query

Whether this provider supports querying at all.

queryByKeyword

public static final AssetProviderCapability queryByKeyword

Whether this provider supports querying by keyword.

queryWithPagination

public static final AssetProviderCapability queryWithPagination

Whether this provider supports pagination.

queryWithSorting

public static final AssetProviderCapability queryWithSorting

Whether this provider supports sorting in queries.

queryWithProviderSpecificString

public static final AssetProviderCapability queryWithProviderSpecificString

Whether this provider supports queries with an additional provider-specific clauses. see AssetQuery.getAdditionalQueryStatement()

Method Detail

values

public static AssetProviderCapability[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AssetProviderCapability c : AssetProviderCapability.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AssetProviderCapability valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null