Author: ssmiweve
Date: 2008-04-17 12:06:57 +0200 (Thu, 17 Apr 2008)
New Revision: 6476
Modified:
branches/2.16/data-model-api/src/main/java/no/sesat/search/datamodel/generic/StringDataObject.java
Log:
javadoc
Modified:
branches/2.16/data-model-api/src/main/java/no/sesat/search/datamodel/generic/StringDataObject.java
===================================================================
---
branches/2.16/data-model-api/src/main/java/no/sesat/search/datamodel/generic/StringDataObject.java
2008-04-17 08:19:41 UTC (rev 6475)
+++
branches/2.16/data-model-api/src/main/java/no/sesat/search/datamodel/generic/StringDataObject.java
2008-04-17 10:06:57 UTC (rev 6476)
@@ -26,32 +26,38 @@
import static no.sesat.search.datamodel.access.ControlLevel.VIEW_CONSTRUCTION;
import no.sesat.search.datamodel.access.AccessDisallow;
-/**
+/** DataObject wrapping a String providing getters for url encoded and xml
escaped variants.
+ *
+ * String should not be used directly during the rendering stage.
+ * Hence getString has the annontation
<code>@AccessDisallow({VIEW_CONSTRUCTION})</code>.
+ *
*
* @author <a href="mailto:[EMAIL PROTECTED]">Mck</a>
* @version <tt>$Id$</tt>
*/
@DataObject
public interface StringDataObject extends Serializable{
- /**
- *
+ /** The plain value of the string.
+ * Disallowed during rendering for security reasons.
* @return
*/
@AccessDisallow({VIEW_CONSTRUCTION})
String getString();
- /**
+ /** The UTF8 url encoded variant of the string.
+ * Encoding must meet those requirements stated in java.net.URLEncoder
*
- * @return
+ * @return UTF8 url encoded variant of the string.
*/
String getUtf8UrlEncoded();
- /**
+ /** The ISO-88591 url encoded variant of the string.
+ * Encoding must meet those requirements stated in java.net.URLEncoder
*
- * @return
+ * @return ISO-88591 url encoded variant of the string.
*/
String getIso88591UrlEncoded();
- /**
+ /** The xml escaped variant of the string.
*
- * @return
+ * @return xmlescaped variant of the string.
*/
String getXmlEscaped();
}
_______________________________________________
Kernel-commits mailing list
[email protected]
http://sesat.no/mailman/listinfo/kernel-commits
