summaryrefslogtreecommitdiff
path: root/src/main
diff options
context:
space:
mode:
authorBrian S. O'Neill <bronee@gmail.com>2007-11-07 19:47:07 +0000
committerBrian S. O'Neill <bronee@gmail.com>2007-11-07 19:47:07 +0000
commitb2ca98bf9e2e4c2f68cbda32155a29ebd798bd9d (patch)
treece3d810dcb67af5eac931cb734462e43cfb26a40 /src/main
parent0328b812f5289113b6a27a2d6d37d47e2f539137 (diff)
Comments for new Name annotation.
Diffstat (limited to 'src/main')
-rw-r--r--src/main/java/com/amazon/carbonado/Alias.java1
-rw-r--r--src/main/java/com/amazon/carbonado/Name.java22
-rw-r--r--src/main/java/com/amazon/carbonado/info/StorableIntrospector.java1
3 files changed, 15 insertions, 9 deletions
diff --git a/src/main/java/com/amazon/carbonado/Alias.java b/src/main/java/com/amazon/carbonado/Alias.java
index 76caade..07e93bc 100644
--- a/src/main/java/com/amazon/carbonado/Alias.java
+++ b/src/main/java/com/amazon/carbonado/Alias.java
@@ -42,6 +42,7 @@ import java.lang.annotation.*;
* </pre>
*
* @author Brian S O'Neill
+ * @see Name
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
diff --git a/src/main/java/com/amazon/carbonado/Name.java b/src/main/java/com/amazon/carbonado/Name.java
index 7fae973..bc3da42 100644
--- a/src/main/java/com/amazon/carbonado/Name.java
+++ b/src/main/java/com/amazon/carbonado/Name.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2006 Amazon Technologies, Inc. or its affiliates.
+ * Copyright 2007 Amazon Technologies, Inc. or its affiliates.
* Amazon, Amazon.com and Carbonado are trademarks or registered trademarks
* of Amazon Technologies, Inc. or its affiliates. All rights reserved.
*
@@ -25,21 +25,25 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * Identifies prefered name for a {@link Storable} or a Storable property. By default the
- * property name is following the convention of a java Bean. Use this annotation when
- * you want to use a prefered name for a storable property. .
+ * Overrides the primary name of a Storable property. By default, the primary
+ * name of a property is determined by JavaBeans conventions. When overridden,
+ * all references to the named property must use the new name.
*
* <p>Example:<pre>
+ * &#64;PrimaryKey(<b>"userId"</b>)
* public interface UserInfo extends Storable&lt;UserInfo&gt; {
- * <b>&#64;Name("MyName")</b>
- * String getName();
- * void setName(String name);
+ * <b>&#64;Name("userId")</b>
+ * long getUserInfoID();
+ * void setUserInfoID(long id);
*
* ...
* }
* </pre>
*
+ * @since 1.2
* @author Fang Chen
+ * @author Brian S O'Neill
+ * @see Alias
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@@ -47,8 +51,8 @@ import java.lang.annotation.Target;
public @interface Name {
/**
- * The prefered name of the property
+ * Name assigned to the property.
*/
String value();
-} \ No newline at end of file
+}
diff --git a/src/main/java/com/amazon/carbonado/info/StorableIntrospector.java b/src/main/java/com/amazon/carbonado/info/StorableIntrospector.java
index c62e3ce..7e8fbf8 100644
--- a/src/main/java/com/amazon/carbonado/info/StorableIntrospector.java
+++ b/src/main/java/com/amazon/carbonado/info/StorableIntrospector.java
@@ -77,6 +77,7 @@ import com.amazon.carbonado.lob.Lob;
* examination failed.
*
* @author Brian S O'Neill
+ * @author Fang Chen
*/
public class StorableIntrospector {
// Weakly maps Class objects to softly referenced StorableInfo objects.