X-Git-Url: https://dev.e-taxonomy.eu/gitweb/cdmlib.git/blobdiff_plain/de6a1846dbf351a504c8e8d599527306a292db29..33f9b501bdb2e894f4e57b280a932717eb14525b:/cdmlib-model/src/main/java/eu/etaxonomy/cdm/strategy/INameCacheStrategy.java?ds=sidebyside

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 4377617aa5..c958787b10 100644
--- 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;
 
 /**
+ * A name cache rendering strategy for all TaxonNameBase subclasses.
+ * Different TaxonNameBase subclasses could have different strategies.
  * @author a.mueller
  *
+ * @param <T> The concrete TaxonName class this strategy applies for
  */
 public interface INameCacheStrategy<T extends TaxonNameBase> extends IStrategy {
 	
-	//returns the composed name string without author or year
+	/**
+	 * returns the composed name string without author or year
+	 * @param object
+	 * @return
+	 */
 	public String getNameCache(T object);
 	
-	//returns the composed name string with author and/or year
+
+	/**
+	 * returns the composed name string with author and/or year
+	 * @param object
+	 * @return
+	 */
 	public String getTitleCache(T object);
 
-	//returns an array of name tokens that together make up the full name
-	// a token can be a String (for name parts), Rank, AuthorTeam (for entire authorship string), 
-	// Date or ReferenceBase
-	// Example: ["Abies","alba",Rank.SUBSPECIES,"alpina",AuthorTeam("Greuther (L.)")]
+	/**
+	 * returns an array of name tokens that together make up the full name
+	 * a token can be a String (for name parts), Rank, AuthorTeam (for entire authorship string), 
+	 * Date or ReferenceBase
+	 * Example: ["Abies","alba",Rank.SUBSPECIES,"alpina",AuthorTeam("Greuther (L.)")]
+	 * @param object
+	 * @return
+	 */
 	public List<Object> getTaggedName(T object);
 }