correct java docs

This commit is contained in:
Albert Shift 2015-06-19 13:56:09 -07:00
parent 49b7c07ab2
commit ba416ba1ff
3 changed files with 34 additions and 2 deletions

View file

@ -23,7 +23,7 @@ import java.lang.annotation.Target;
import com.noorq.casser.mapping.OrderingDirection; import com.noorq.casser.mapping.OrderingDirection;
/** /**
* @ClusteringColumn is the family column in legacy Cassandra API * ClusteringColumn is the family column in legacy Cassandra API
* *
* The purpose of this column is have additional dimension in the table. * The purpose of this column is have additional dimension in the table.
* Both @PartitionKey and @ClusteringColumn together are parts of the primary key of the table. * Both @PartitionKey and @ClusteringColumn together are parts of the primary key of the table.

View file

@ -21,7 +21,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target; import java.lang.annotation.Target;
/** /**
* @StaticColumn annotation is using to define a static column in Cassandra Table * StaticColumn annotation is using to define a static column in Cassandra Table
* *
* It does not have effect in @UDT and @Tuple types and in @Table-s that does not have @ClusteringColumn-s * It does not have effect in @UDT and @Tuple types and in @Table-s that does not have @ClusteringColumn-s
* *

View file

@ -108,6 +108,8 @@ public final class Types {
* It supports only simple data type (not Collection, UDT or Tuple) * It supports only simple data type (not Collection, UDT or Tuple)
* *
* In case if you need UDT sub-type in the list, consider @UDTList annotation * In case if you need UDT sub-type in the list, consider @UDTList annotation
*
* @return data type name of the value
*/ */
DataType.Name value(); DataType.Name value();
@ -138,6 +140,8 @@ public final class Types {
* It supports only simple data type (not Collection, UDT or Tuple) * It supports only simple data type (not Collection, UDT or Tuple)
* *
* In case if you need UDT key sub-type in the map, consider @UDTKeyMap or @UDTMap annotations * In case if you need UDT key sub-type in the map, consider @UDTKeyMap or @UDTMap annotations
*
* @return data type name of the key
*/ */
DataType.Name key(); DataType.Name key();
@ -147,6 +151,8 @@ public final class Types {
* It supports only simple data type (not Collection, UDT or Tuple) * It supports only simple data type (not Collection, UDT or Tuple)
* *
* In case if you need UDT value sub-type in the map, consider @UDTValueMap or @UDTMap annotations * In case if you need UDT value sub-type in the map, consider @UDTValueMap or @UDTMap annotations
*
* @return data type name of the value
*/ */
DataType.Name value(); DataType.Name value();
@ -192,6 +198,8 @@ public final class Types {
* It supports only simple data type (not Collection, UDT or Tuple) * It supports only simple data type (not Collection, UDT or Tuple)
* *
* In case if you need UDT sub-type in the set, consider @UDTSet annotation * In case if you need UDT sub-type in the set, consider @UDTSet annotation
*
* @return data type name of the value
*/ */
DataType.Name value(); DataType.Name value();
@ -213,6 +221,8 @@ public final class Types {
/** /**
* Class name of the custom user type that is implementation of the type * Class name of the custom user type that is implementation of the type
*
* @return class name of the custom type implementation
*/ */
String className(); String className();
@ -273,6 +283,8 @@ public final class Types {
* *
* In case if Java type is the model interface with @Tuple annotation then * In case if Java type is the model interface with @Tuple annotation then
* all methods in this interface can have Types annotations that can be complex types as well. * all methods in this interface can have Types annotations that can be complex types as well.
*
* @return data type name sequence
*/ */
DataType.Name[] value() default {}; DataType.Name[] value() default {};
@ -297,6 +309,8 @@ public final class Types {
* *
* In case of Java type is the model interface with @UDT annotation then * In case of Java type is the model interface with @UDT annotation then
* this field is not using since model interface defines UserDefinedType with specific name * this field is not using since model interface defines UserDefinedType with specific name
*
* @return UDT name
*/ */
String value() default ""; String value() default "";
@ -308,6 +322,8 @@ public final class Types {
* forceQuote will add additional quotes around this name in all CQL queries. * forceQuote will add additional quotes around this name in all CQL queries.
* *
* Default value is false. * Default value is false.
*
* @return true if quotation is needed
*/ */
boolean forceQuote() default false; boolean forceQuote() default false;
@ -335,6 +351,8 @@ public final class Types {
/** /**
* Clarification of using the UDT data type as a key sub-type in the collection. * Clarification of using the UDT data type as a key sub-type in the collection.
*
* @return annotation of UDT type
*/ */
UDT key(); UDT key();
@ -344,6 +362,8 @@ public final class Types {
* It supports only simple data type (not Collection, UDT or Tuple) * It supports only simple data type (not Collection, UDT or Tuple)
* *
* In case if you need UDT value sub-type in the map, consider @UDTMap annotations * In case if you need UDT value sub-type in the map, consider @UDTMap annotations
*
* @return data type name of the value
*/ */
DataType.Name value(); DataType.Name value();
@ -370,6 +390,8 @@ public final class Types {
/** /**
* Clarification of using the UDT data type as a sub-type in the collection. * Clarification of using the UDT data type as a sub-type in the collection.
*
* @return annotation of the UDT value
*/ */
UDT value(); UDT value();
@ -397,12 +419,16 @@ public final class Types {
/** /**
* Clarification of using the UDT data type as a key sub-type in the collection. * Clarification of using the UDT data type as a key sub-type in the collection.
*
* @return annotation of the UDT key
*/ */
UDT key(); UDT key();
/** /**
* Clarification of using the UDT data type as a value sub-type in the collection. * Clarification of using the UDT data type as a value sub-type in the collection.
*
* @return annotation of the UDT value
*/ */
UDT value(); UDT value();
@ -430,6 +456,8 @@ public final class Types {
/** /**
* Clarification of using the UDT data type as a sub-type in the collection. * Clarification of using the UDT data type as a sub-type in the collection.
*
* @return annotation of the UDT value
*/ */
UDT value(); UDT value();
@ -460,12 +488,16 @@ public final class Types {
* It supports only simple data type (not Collection, UDT or Tuple) * It supports only simple data type (not Collection, UDT or Tuple)
* *
* In case if you need UDT key sub-type in the map, consider @UDTMap annotations * In case if you need UDT key sub-type in the map, consider @UDTMap annotations
*
* @return data type name of the key
*/ */
DataType.Name key(); DataType.Name key();
/** /**
* Clarification of using the UDT data type as a value sub-type in the collection. * Clarification of using the UDT data type as a value sub-type in the collection.
*
* @return annotation of the UDT value
*/ */
UDT value(); UDT value();