Added common capabilities

1 files changed, 37 insertions, 0 deletions

diff --git a/src/main/java/com/amazon/carbonado/capability/IndexInfoCapability.java b/src/main/java/com/amazon/carbonado/capability/IndexInfoCapability.java
new file mode 100644
index 0000000..023bc53
--- /dev/null
+++ b/src/main/java/com/amazon/carbonado/capability/IndexInfoCapability.java
@@ -0,0 +1,37 @@
+/*

+ * Copyright 2006 Amazon Technologies, Inc. or its affiliates.

+ * Amazon, Amazon.com and Carbonado are trademarks or registered trademarks

+ * of Amazon Technologies, Inc. or its affiliates.  All rights reserved.

+ *

+ * Licensed under the Apache License, Version 2.0 (the "License");

+ * you may not use this file except in compliance with the License.

+ * You may obtain a copy of the License at

+ *

+ *     http://www.apache.org/licenses/LICENSE-2.0

+ *

+ * Unless required by applicable law or agreed to in writing, software

+ * distributed under the License is distributed on an "AS IS" BASIS,

+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

+ * See the License for the specific language governing permissions and

+ * limitations under the License.

+ */

+

+package com.amazon.carbonado.capability;

+

+import com.amazon.carbonado.RepositoryException;

+import com.amazon.carbonado.Storable;

+

+/**

+ * Capability for getting information about physical indexes for storables.

+ *

+ * @author Brian S O'Neill

+ */

+public interface IndexInfoCapability extends Capability {

+    /**

+     * Returns information about the known indexes for the given storable

+     * type. The array might be empty, but it is never null. The array is a

+     * copy, and so it may be safely modified.

+     */

+    <S extends Storable> IndexInfo[] getIndexInfo(Class<S> storableType)

+        throws RepositoryException;

+}