Permalink
Browse files

Merge pull request #580 from akaIDIOT/documentation-fix

Document string-formatted arguments
  • Loading branch information...
zznate committed Jan 16, 2013
2 parents 7d92c51 + 0c68fa7 commit 14f1ea519a2ba5a0b3494365aae0d793c4a08857
@@ -57,6 +57,11 @@ public CassandraHostConfigurator() {
this.hosts = null;
}
+ /**
+ * Creates a new {@code CassandraHostConfigurator} from the specified hosts String, formatted as
+ * {@code host[:port][,host[:port]...]}.
+ * @param hosts The hosts to create {@link CassandraHost}s from.
+ */
public CassandraHostConfigurator(String hosts) {
this.hosts = hosts;
}
@@ -90,6 +95,11 @@ public void applyConfig(CassandraHost cassandraHost) {
}
}
+ /**
+ * Specifies the hosts String, formatted as
+ * {@code host[:port][,host[:port]...]}.
+ * @param hosts The hosts to create {@link CassandraHost}s from.
+ */
public void setHosts(String hosts) {
this.hosts = hosts;
}
@@ -28,6 +28,14 @@
void setSubComparatorType(ComparatorType subComparitorType);
String getComparatorTypeAlias();
+
+ /**
+ * Sets the type alias for the comparator to be used for the row keys of the column family.
+ * For composite types, supply the alias in the following format:
+ * {@code (TypeName1, TypeName2, ...)}.
+ * @param alias An alias String defining the comparator to be used for the row keys.
+ * @see <a href="http://www.datastax.com/docs/1.1/ddl/column_family#about-data-types-comparators-and-validators">DataStax column family reference</a>
+ */
void setComparatorTypeAlias(String alias);
String getSubComparatorTypeAlias();

0 comments on commit 14f1ea5

Please sign in to comment.