summaryrefslogtreecommitdiff
path: root/src/main/java/com
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/java/com')
-rw-r--r--src/main/java/com/amazon/carbonado/Name.java35
1 files changed, 35 insertions, 0 deletions
diff --git a/src/main/java/com/amazon/carbonado/Name.java b/src/main/java/com/amazon/carbonado/Name.java
index 39b1ba8..7fae973 100644
--- a/src/main/java/com/amazon/carbonado/Name.java
+++ b/src/main/java/com/amazon/carbonado/Name.java
@@ -1,3 +1,21 @@
+/*
+ * Copyright 2006 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.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
package com.amazon.carbonado;
import java.lang.annotation.Documented;
@@ -6,6 +24,23 @@ import java.lang.annotation.Retention;
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. .
+ *
+ * <p>Example:<pre>
+ * public interface UserInfo extends Storable&lt;UserInfo&gt; {
+ * <b>&#64;Name("MyName")</b>
+ * String getName();
+ * void setName(String name);
+ *
+ * ...
+ * }
+ * </pre>
+ *
+ * @author Fang Chen
+ */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})