Author: tho...@jb...
Date: 2008-07-04 11:11:08 -0400 (Fri, 04 Jul 2008)
New Revision: 1526
Modified:
api/trunk/modules/api/src/main/java/org/jboss/bpm/client/Attachments.java
Log:
javadoc
Modified: api/trunk/modules/api/src/main/java/org/jboss/bpm/client/Attachments.java
===================================================================
--- api/trunk/modules/api/src/main/java/org/jboss/bpm/client/Attachments.java 2008-07-04 14:56:56 UTC (rev 1525)
+++ api/trunk/modules/api/src/main/java/org/jboss/bpm/client/Attachments.java 2008-07-04 15:11:08 UTC (rev 1526)
@@ -26,7 +26,7 @@
import java.util.Collection;
/**
- * An interface for general Attachments
+ * An interface for general Attachments
*
* @author Tho...@jb...
* @since 20-Apr-2007
@@ -72,7 +72,7 @@
private String name;
/**
- * Construct the key with optional class and name
+ * Construct the key with optional class and name
*/
public Key(Class<?> clazz, String name)
{
@@ -80,8 +80,9 @@
this.name = name;
}
- /**
+ /**
* Get the class part for this key
+ *
* @return maybe null
*/
public Class<?> getClassPart()
@@ -89,8 +90,9 @@
return clazz;
}
- /**
+ /**
* Get the name part for this key
+ *
* @return maybe null
*/
public String getNamePart()
@@ -98,7 +100,9 @@
return name;
}
- @Override
+ /**
+ * Two keys are equal if their {@link #toString()} is equal
+ */
public boolean equals(Object obj)
{
if (!(obj instanceof Key))
@@ -108,13 +112,20 @@
return obj.toString().equals(toString());
}
- @Override
+ /**
+ * Two keys have the same hashCode if their {@link #toString()} is equal
+ */
public int hashCode()
{
return toString().hashCode();
}
- @Override
+ /**
+ * Returns the String repesentation of this Key. <p/>
+ * <pre>
+ * "[" + clazz + "," + name + "]"
+ * </pre>
+ */
public String toString()
{
return "[" + (clazz != null ? clazz.getName() : null) + "," + name + "]";
|