[hibernate-commits] Hibernate SVN: r15560 - in search/trunk/src/java/org/hibernate/search/bridge: builtin and 1 other directory.

[hibernate-commits at lists.jboss.org]

Author: hardy.ferentschik
Date: 2008-11-13 10:38:44 -0500 (Thu, 13 Nov 2008)
New Revision: 15560

Modified:
   search/trunk/src/java/org/hibernate/search/bridge/StringBridge.java
   search/trunk/src/java/org/hibernate/search/bridge/TwoWayFieldBridge.java
   search/trunk/src/java/org/hibernate/search/bridge/TwoWayStringBridge.java
   search/trunk/src/java/org/hibernate/search/bridge/builtin/UrlBridge.java
Log:
Javadoc changes.

Modified: search/trunk/src/java/org/hibernate/search/bridge/StringBridge.java
===================================================================
--- search/trunk/src/java/org/hibernate/search/bridge/StringBridge.java	2008-11-13 10:56:39 UTC (rev 15559)
+++ search/trunk/src/java/org/hibernate/search/bridge/StringBridge.java	2008-11-13 15:38:44 UTC (rev 15560)
@@ -14,8 +14,7 @@
 public interface StringBridge {
 	
 	/**
-	 * convert the object representation to a String
-	 * The return String must not be null, it can be empty though
+	 * {@inheritDoc}
 	 */
 	String objectToString(Object object);
 }

Modified: search/trunk/src/java/org/hibernate/search/bridge/TwoWayFieldBridge.java
===================================================================
--- search/trunk/src/java/org/hibernate/search/bridge/TwoWayFieldBridge.java	2008-11-13 10:56:39 UTC (rev 15559)
+++ search/trunk/src/java/org/hibernate/search/bridge/TwoWayFieldBridge.java	2008-11-13 15:38:44 UTC (rev 15560)
@@ -4,28 +4,29 @@
 import org.apache.lucene.document.Document;
 
 /**
- * A FieldBrige able to convert the index representation back into an object without losing information
+ * A <code>FieldBridge</code> able to convert the index representation back into an object without losing information.
+ * Any bridge expected to process a document id should implement this interface.
  *
- * Any bridge expected to process a document id should implement this interface
- * EXPERIMENTAL Consider this interface as private
- *
  * @author Emmanuel Bernard
  */
-//FIXME rework the interface inheritance there are some common concepts with StringBridge
+// FIXME rework the interface inheritance there are some common concepts with StringBridge
 public interface TwoWayFieldBridge extends FieldBridge {
 	/**
-	 * build the element object from the Document
+	 * Build the element object from the <code>Document</code>
 	 *
-	 * The return value is the Entity id
+	 * @param name field name
+	 * @param document document
 	 *
-	 * @param name	 field name
-	 * @param document document
+	 * @return The return value is the entity property value.
 	 */
 	Object get(String name, Document document);
 
 	/**
-	 * convert the object representation to a String
-	 * The return String must not be null, it can be empty though
+	 * Convert the object representation to a string.
+	 *
+	 * @param object The object to index.
+	 * @return string (index) representationT of the specified object. Must not be <code>null</code>, but
+	 *         can be empty.
 	 */
 	String objectToString(Object object);
 }

Modified: search/trunk/src/java/org/hibernate/search/bridge/TwoWayStringBridge.java
===================================================================
--- search/trunk/src/java/org/hibernate/search/bridge/TwoWayStringBridge.java	2008-11-13 10:56:39 UTC (rev 15559)
+++ search/trunk/src/java/org/hibernate/search/bridge/TwoWayStringBridge.java	2008-11-13 15:38:44 UTC (rev 15560)
@@ -14,8 +14,9 @@
  * @author Emmanuel Bernard
  */
 public interface TwoWayStringBridge extends StringBridge {
+
 	/**
-	 * Convert the string representation to an object
+	 * {@inheritDoc}
 	 */
 	Object stringToObject(String stringValue);
 }

Modified: search/trunk/src/java/org/hibernate/search/bridge/builtin/UrlBridge.java
===================================================================
--- search/trunk/src/java/org/hibernate/search/bridge/builtin/UrlBridge.java	2008-11-13 10:56:39 UTC (rev 15559)
+++ search/trunk/src/java/org/hibernate/search/bridge/builtin/UrlBridge.java	2008-11-13 15:38:44 UTC (rev 15560)
@@ -9,7 +9,7 @@
 import org.hibernate.annotations.common.util.StringHelper;
 
 /**
- * Bridge for <code>URL</code>
+ * Bridge for <code>URL</code>s.
  *
  * @author Emmanuel Bernard
  */
@@ -20,10 +20,10 @@
 		}
 		else {
 			try {
-				return new URL(stringValue);
+				return new URL( stringValue );
 			}
-			catch (MalformedURLException e) {
-				throw new SearchException("Unable to build URL: " + stringValue, e);
+			catch ( MalformedURLException e ) {
+				throw new SearchException( "Unable to build URL: " + stringValue, e );
 			}
 		}
 	}