Repository: incubator-usergrid
Updated Branches:
  refs/heads/USERGRID-501 33b1b69fc -> c18ba594d


add comments for interfaces


Project: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/repo
Commit: 
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/commit/c18ba594
Tree: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/tree/c18ba594
Diff: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/diff/c18ba594

Branch: refs/heads/USERGRID-501
Commit: c18ba594dc6e88662a30d525b2ddee34d1ed30d7
Parents: 33b1b69
Author: Shawn Feldman <[email protected]>
Authored: Mon Mar 30 10:08:28 2015 -0600
Committer: Shawn Feldman <[email protected]>
Committed: Mon Mar 30 10:08:28 2015 -0600

----------------------------------------------------------------------
 .../usergrid/persistence/index/IndexCache.java      | 12 +++++++++++-
 .../usergrid/persistence/index/IndexIdentifier.java | 16 +++++++++++++++-
 2 files changed, 26 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/c18ba594/stack/corepersistence/queryindex/src/main/java/org/apache/usergrid/persistence/index/IndexCache.java
----------------------------------------------------------------------
diff --git 
a/stack/corepersistence/queryindex/src/main/java/org/apache/usergrid/persistence/index/IndexCache.java
 
b/stack/corepersistence/queryindex/src/main/java/org/apache/usergrid/persistence/index/IndexCache.java
index 253c66d..e852230 100644
--- 
a/stack/corepersistence/queryindex/src/main/java/org/apache/usergrid/persistence/index/IndexCache.java
+++ 
b/stack/corepersistence/queryindex/src/main/java/org/apache/usergrid/persistence/index/IndexCache.java
@@ -20,10 +20,20 @@
 package org.apache.usergrid.persistence.index;
 
 /**
- * Classy class class.
+ * Cache for index lookups
  */
 public interface IndexCache {
+    /**
+     * get index based on alias name
+     * @param alias
+     * @param aliasType
+     * @return
+     */
     String[] getIndexes(IndexAlias alias, AliasedEntityIndex.AliasType 
aliasType);
 
+    /**
+     * invalidate cache
+     * @param alias
+     */
     void invalidate(IndexAlias alias);
 }

http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/c18ba594/stack/corepersistence/queryindex/src/main/java/org/apache/usergrid/persistence/index/IndexIdentifier.java
----------------------------------------------------------------------
diff --git 
a/stack/corepersistence/queryindex/src/main/java/org/apache/usergrid/persistence/index/IndexIdentifier.java
 
b/stack/corepersistence/queryindex/src/main/java/org/apache/usergrid/persistence/index/IndexIdentifier.java
index 22b82de..f393ee3 100644
--- 
a/stack/corepersistence/queryindex/src/main/java/org/apache/usergrid/persistence/index/IndexIdentifier.java
+++ 
b/stack/corepersistence/queryindex/src/main/java/org/apache/usergrid/persistence/index/IndexIdentifier.java
@@ -20,12 +20,26 @@
 package org.apache.usergrid.persistence.index;
 
 /**
- * Classy class class.
+ * Identifier for where an index is in underlying server
  */
 public interface IndexIdentifier {
+
+    /**
+     * get the alias name
+     * @return
+     */
     IndexAlias getAlias();
 
+    /**
+     * get index name from suffix
+     * @param suffix
+     * @return
+     */
     String getIndex(String suffix);
 
+    /**
+     * return unique string
+     * @return
+     */
     String toString();
 }

Reply via email to