(no commit message)

[cdmlib.git] / cdmlib-model / src / main / java / eu / etaxonomy / cdm / strategy / INameCacheStrategy.java

diff --git a/cdmlib-model/src/main/java/eu/etaxonomy/cdm/strategy/INameCacheStrategy.java b/cdmlib-model/src/main/java/eu/etaxonomy/cdm/strategy/INameCacheStrategy.java
index 4377617aa5aa08c480b57effa66533aff6d3deba..c958787b104a0415f247cf925511a95512f8435e 100644 (file)
--- a/cdmlib-model/src/main/java/eu/etaxonomy/cdm/strategy/INameCacheStrategy.java
+++ b/cdmlib-model/src/main/java/eu/etaxonomy/cdm/strategy/INameCacheStrategy.java
@@ -8,20 +8,36 @@ import java.util.List;
 import eu.etaxonomy.cdm.model.name.TaxonNameBase;\r
 \r
 /**\r
+ * A name cache rendering strategy for all TaxonNameBase subclasses.\r
+ * Different TaxonNameBase subclasses could have different strategies.\r
  * @author a.mueller\r
  *\r
+ * @param <T> The concrete TaxonName class this strategy applies for\r
  */\r
 public interface INameCacheStrategy<T extends TaxonNameBase> extends IStrategy {\r
        \r
-       //returns the composed name string without author or year\r
+       /**\r
+        * returns the composed name string without author or year\r
+        * @param object\r
+        * @return\r
+        */\r
        public String getNameCache(T object);\r
        \r
-       //returns the composed name string with author and/or year\r
+\r
+       /**\r
+        * returns the composed name string with author and/or year\r
+        * @param object\r
+        * @return\r
+        */\r
        public String getTitleCache(T object);\r
 \r
-       //returns an array of name tokens that together make up the full name\r
-       // a token can be a String (for name parts), Rank, AuthorTeam (for entire authorship string), \r
-       // Date or ReferenceBase\r
-       // Example: ["Abies","alba",Rank.SUBSPECIES,"alpina",AuthorTeam("Greuther (L.)")]\r
+       /**\r
+        * returns an array of name tokens that together make up the full name\r
+        * a token can be a String (for name parts), Rank, AuthorTeam (for entire authorship string), \r
+        * Date or ReferenceBase\r
+        * Example: ["Abies","alba",Rank.SUBSPECIES,"alpina",AuthorTeam("Greuther (L.)")]\r
+        * @param object\r
+        * @return\r
+        */\r
        public List<Object> getTaggedName(T object);\r
 }\r