From 9811cadb568c8f4e67b7d86cfd191eceefe85158 Mon Sep 17 00:00:00 2001 From: Matthew Adams Date: Thu, 12 Dec 2013 11:30:25 -0600 Subject: [PATCH] updated/added javadocs --- .../core/keyspace/ColumnChangeSpecification.java | 5 +++++ .../cassandra/core/keyspace/ColumnSpecification.java | 12 ++++++------ .../core/keyspace/ColumnTypeChangeSpecification.java | 5 +++++ .../core/keyspace/DropColumnSpecification.java | 5 +++++ 4 files changed, 21 insertions(+), 6 deletions(-) diff --git a/spring-cassandra/src/main/java/org/springframework/cassandra/core/keyspace/ColumnChangeSpecification.java b/spring-cassandra/src/main/java/org/springframework/cassandra/core/keyspace/ColumnChangeSpecification.java index 2c9eebc8c..6cea473f8 100644 --- a/spring-cassandra/src/main/java/org/springframework/cassandra/core/keyspace/ColumnChangeSpecification.java +++ b/spring-cassandra/src/main/java/org/springframework/cassandra/core/keyspace/ColumnChangeSpecification.java @@ -18,6 +18,11 @@ package org.springframework.cassandra.core.keyspace; import static org.springframework.cassandra.core.cql.CqlStringUtils.checkIdentifier; import static org.springframework.cassandra.core.cql.CqlStringUtils.identifize; +/** + * Base class for column change specifications. + * + * @author Matthew T. Adams + */ public abstract class ColumnChangeSpecification { private String name; diff --git a/spring-cassandra/src/main/java/org/springframework/cassandra/core/keyspace/ColumnSpecification.java b/spring-cassandra/src/main/java/org/springframework/cassandra/core/keyspace/ColumnSpecification.java index d232a612a..9c2d0ba03 100644 --- a/spring-cassandra/src/main/java/org/springframework/cassandra/core/keyspace/ColumnSpecification.java +++ b/spring-cassandra/src/main/java/org/springframework/cassandra/core/keyspace/ColumnSpecification.java @@ -28,11 +28,11 @@ import org.springframework.cassandra.core.Ordering; import com.datastax.driver.core.DataType; /** - * Builder class to help construct CQL statements that involve column manipulation. Not threadsafe. + * Builder class to specify columns. *

* Use {@link #name(String)} and {@link #type(String)} to set the name and type of the column, respectively. To specify - * a PRIMARY KEY column, use {@link #clustered()} or {@link #clustered(Ordering)}. To specify that the - * PRIMARY KEY column is or is part of the partition key, use {@link #partitioned()} instead of + * a clustered PRIMARY KEY column, use {@link #clustered()} or {@link #clustered(Ordering)}. To specify + * that the PRIMARY KEY column is or is part of the partition key, use {@link #partitioned()} instead of * {@link #clustered()} or {@link #clustered(Ordering)}. * * @author Matthew T. Adams @@ -105,7 +105,7 @@ public class ColumnSpecification { } /** - * Identifies this column as a primary key column with the given ordering. Sets the column's {@link #keyType} to + * Identifies this column as a clustered key column with the given ordering. Sets the column's {@link #keyType} to * {@link PrimaryKeyType#CLUSTERED} and its {@link #ordering} to the given {@link Ordering}. * * @return this @@ -115,8 +115,8 @@ public class ColumnSpecification { } /** - * Toggles the identification of this column as a primary key column. If the given boolean is true, then - * sets the column's {@link #keyType} to {@link PrimaryKeyType#PARTITIONED} and {@link #ordering} to the given + * Toggles the identification of this column as a clustered key column. If the given boolean is true, + * then sets the column's {@link #keyType} to {@link PrimaryKeyType#PARTITIONED} and {@link #ordering} to the given * {@link Ordering} , else sets both {@link #keyType} and {@link #ordering} to null. * * @return this diff --git a/spring-cassandra/src/main/java/org/springframework/cassandra/core/keyspace/ColumnTypeChangeSpecification.java b/spring-cassandra/src/main/java/org/springframework/cassandra/core/keyspace/ColumnTypeChangeSpecification.java index c978623f2..814cfcd7a 100644 --- a/spring-cassandra/src/main/java/org/springframework/cassandra/core/keyspace/ColumnTypeChangeSpecification.java +++ b/spring-cassandra/src/main/java/org/springframework/cassandra/core/keyspace/ColumnTypeChangeSpecification.java @@ -19,6 +19,11 @@ import org.springframework.util.Assert; import com.datastax.driver.core.DataType; +/** + * Base class for column changes that include {@link DataType} information. + * + * @author Matthew T. Adams + */ public abstract class ColumnTypeChangeSpecification extends ColumnChangeSpecification { private DataType type; diff --git a/spring-cassandra/src/main/java/org/springframework/cassandra/core/keyspace/DropColumnSpecification.java b/spring-cassandra/src/main/java/org/springframework/cassandra/core/keyspace/DropColumnSpecification.java index 19adf19b1..62828fd18 100644 --- a/spring-cassandra/src/main/java/org/springframework/cassandra/core/keyspace/DropColumnSpecification.java +++ b/spring-cassandra/src/main/java/org/springframework/cassandra/core/keyspace/DropColumnSpecification.java @@ -15,6 +15,11 @@ */ package org.springframework.cassandra.core.keyspace; +/** + * A specification to drop a column. + * + * @author Matthew T. Adams + */ public class DropColumnSpecification extends ColumnChangeSpecification { public DropColumnSpecification(String name) {