This is an automated email from the ASF dual-hosted git repository.
frankgh pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/cassandra-analytics.git
The following commit(s) were added to refs/heads/trunk by this push:
new e60bf5bb CASSANALYTICS-140: Clean up non-ASCII characters in main
source JavaDoc and comments (#210)
e60bf5bb is described below
commit e60bf5bbd19d80473ca84465954fd49da9b88150
Author: Tejas Lodaya <[email protected]>
AuthorDate: Tue May 19 14:46:58 2026 -0700
CASSANALYTICS-140: Clean up non-ASCII characters in main source JavaDoc and
comments (#210)
Several source files contain non-ASCII characters in JavaDoc and inline
comments (micro sign, rightwards arrow, em-dash). javac compiled with
the US-ASCII default encoding rejects these with "unmappable character"
errors, which the JIRA reproduces.
Replace the offenders in src/main/ across the affected modules with
ASCII-equivalent JavaDoc:
- micro sign 'mu' in time-unit lists in CreateSnapshotRequest,
RequestContext, and SidecarClient becomes the HTML entity
µs. The 'mu-s' symbol still renders in generated Javadoc HTML
but the source is ASCII.
- rightwards arrow in AbstractBulkWriterContext and RecordWriter
becomes ->.
- em-dash in KafkaPublisher becomes --.
Test files are intentionally left untouched: their use of the two-dot
leader character matches the actual output of Guava's
com.google.common.collect.Range#toString and changing it would break
the assertions.
Patch by Tejas Lodaya; reviewed by Saranya Krishnakumar, Francisco Guerrero
for CASSANALYTICS-140
---
.../cassandra/sidecar/common/request/CreateSnapshotRequest.java | 2 +-
.../java/org/apache/cassandra/sidecar/client/RequestContext.java | 2 +-
.../java/org/apache/cassandra/sidecar/client/SidecarClient.java | 2 +-
.../main/java/org/apache/cassandra/cdc/kafka/KafkaPublisher.java | 2 +-
.../cassandra/spark/bulkwriter/AbstractBulkWriterContext.java | 6 +++---
.../java/org/apache/cassandra/spark/bulkwriter/RecordWriter.java | 4 ++--
6 files changed, 9 insertions(+), 9 deletions(-)
diff --git
a/analytics-sidecar-client-common/src/main/java/org/apache/cassandra/sidecar/common/request/CreateSnapshotRequest.java
b/analytics-sidecar-client-common/src/main/java/org/apache/cassandra/sidecar/common/request/CreateSnapshotRequest.java
index addccabc..b2402a3a 100644
---
a/analytics-sidecar-client-common/src/main/java/org/apache/cassandra/sidecar/common/request/CreateSnapshotRequest.java
+++
b/analytics-sidecar-client-common/src/main/java/org/apache/cassandra/sidecar/common/request/CreateSnapshotRequest.java
@@ -36,7 +36,7 @@ public class CreateSnapshotRequest extends
SnapshotRequest<Void>
* @param snapshotTTL an optional time to live option for the snapshot
(available since Cassandra 4.1+)
* The TTL option must specify the units, for example
2d represents a TTL for 2 days;
* 1h represents a TTL of 1 hour, etc. Valid units are
{@code d}, {@code h}, {@code s},
- * {@code ms}, {@code us}, {@code µs}, {@code ns}, and
{@code m}.
+ * {@code ms}, {@code us}, {@code µs}, {@code
ns}, and {@code m}.
*/
public CreateSnapshotRequest(String keyspace, String table, String
snapshotName, @Nullable String snapshotTTL)
{
diff --git
a/analytics-sidecar-client/src/main/java/org/apache/cassandra/sidecar/client/RequestContext.java
b/analytics-sidecar-client/src/main/java/org/apache/cassandra/sidecar/client/RequestContext.java
index 21ee1822..6adf7eb5 100644
---
a/analytics-sidecar-client/src/main/java/org/apache/cassandra/sidecar/client/RequestContext.java
+++
b/analytics-sidecar-client/src/main/java/org/apache/cassandra/sidecar/client/RequestContext.java
@@ -411,7 +411,7 @@ public class RequestContext
* @param snapshotTTL an optional time to live option for the
snapshot (available since Cassandra 4.1+)
* The TTL option must specify the units, for
example 2d represents a TTL for 2 days;
* 1h represents a TTL of 1 hour, etc. Valid units
are {@code d}, {@code h}, {@code s},
- * {@code ms}, {@code us}, {@code µs}, {@code ns},
and {@code m}.
+ * {@code ms}, {@code us}, {@code µs}, {@code
ns}, and {@code m}.
* @return a reference to this Builder
*/
public Builder createSnapshotRequest(String keyspace, String
tableName, String snapshotName,
diff --git
a/analytics-sidecar-client/src/main/java/org/apache/cassandra/sidecar/client/SidecarClient.java
b/analytics-sidecar-client/src/main/java/org/apache/cassandra/sidecar/client/SidecarClient.java
index 56b3b31c..c084c4ff 100644
---
a/analytics-sidecar-client/src/main/java/org/apache/cassandra/sidecar/client/SidecarClient.java
+++
b/analytics-sidecar-client/src/main/java/org/apache/cassandra/sidecar/client/SidecarClient.java
@@ -392,7 +392,7 @@ public class SidecarClient implements AutoCloseable,
SidecarClientBlobRestoreExt
* @param snapshotTTL an optional time to live option for the snapshot
(available since Cassandra 4.1+).
* The TTL option must specify the units, for example
2d represents a TTL for 2 days;
* 1h represents a TTL of 1 hour, etc. Valid units are
{@code d}, {@code h}, {@code s},
- * {@code ms}, {@code us}, {@code µs}, {@code ns}, and
{@code m}.
+ * {@code ms}, {@code us}, {@code µs}, {@code
ns}, and {@code m}.
* @return a completable future for the request
*/
public CompletableFuture<Void> createSnapshot(SidecarInstance instance,
diff --git
a/cassandra-analytics-cdc-codec/src/main/java/org/apache/cassandra/cdc/kafka/KafkaPublisher.java
b/cassandra-analytics-cdc-codec/src/main/java/org/apache/cassandra/cdc/kafka/KafkaPublisher.java
index 740274f5..8a9fc2e3 100644
---
a/cassandra-analytics-cdc-codec/src/main/java/org/apache/cassandra/cdc/kafka/KafkaPublisher.java
+++
b/cassandra-analytics-cdc-codec/src/main/java/org/apache/cassandra/cdc/kafka/KafkaPublisher.java
@@ -55,7 +55,7 @@ import
org.apache.kafka.common.serialization.ByteArraySerializer;
*
* <p>The type parameter {@code V} is the value type accepted by the Kafka
producer:
* {@code V = GenericData.Record} for schema-registry paths (the Avro-aware
serializer handles encoding),
- * or {@code V = byte[]} for the no-registry path — see {@link
ByteArrayKafkaPublisher}.
+ * or {@code V = byte[]} for the no-registry path -- see {@link
ByteArrayKafkaPublisher}.
*
* @param <V> the Kafka producer value type
*/
diff --git
a/cassandra-analytics-core/src/main/java/org/apache/cassandra/spark/bulkwriter/AbstractBulkWriterContext.java
b/cassandra-analytics-core/src/main/java/org/apache/cassandra/spark/bulkwriter/AbstractBulkWriterContext.java
index fd2210d0..447285ff 100644
---
a/cassandra-analytics-core/src/main/java/org/apache/cassandra/spark/bulkwriter/AbstractBulkWriterContext.java
+++
b/cassandra-analytics-core/src/main/java/org/apache/cassandra/spark/bulkwriter/AbstractBulkWriterContext.java
@@ -59,9 +59,9 @@ import org.jetbrains.annotations.NotNull;
*
* <p>Broadcastable wrappers used in BulkWriterConfig:
* <ul>
- * <li>{@link IBroadcastableClusterInfo} → reconstructs to {@link
CassandraClusterInfo} or {@link CassandraClusterInfoGroup}</li>
- * <li>{@link BroadcastableJobInfo} → reconstructs to {@link
CassandraJobInfo}</li>
- * <li>{@link BroadcastableSchemaInfo} → reconstructs to {@link
CassandraSchemaInfo}</li>
+ * <li>{@link IBroadcastableClusterInfo} -> reconstructs to {@link
CassandraClusterInfo} or {@link CassandraClusterInfoGroup}</li>
+ * <li>{@link BroadcastableJobInfo} -> reconstructs to {@link
CassandraJobInfo}</li>
+ * <li>{@link BroadcastableSchemaInfo} -> reconstructs to {@link
CassandraSchemaInfo}</li>
* </ul>
*
* <p>Implements KryoSerializable with fail-fast approach to detect missing
Kryo registration.
diff --git
a/cassandra-analytics-core/src/main/java/org/apache/cassandra/spark/bulkwriter/RecordWriter.java
b/cassandra-analytics-core/src/main/java/org/apache/cassandra/spark/bulkwriter/RecordWriter.java
index d707a651..7bf08500 100644
---
a/cassandra-analytics-core/src/main/java/org/apache/cassandra/spark/bulkwriter/RecordWriter.java
+++
b/cassandra-analytics-core/src/main/java/org/apache/cassandra/spark/bulkwriter/RecordWriter.java
@@ -393,8 +393,8 @@ public class RecordWriter
}
// Convert tuples to TupleValue for CQLSSTableWriter
- // - Direct tuple columns: Object[] → TupleValue
- // - Collections with tuples: List<Object[]> → List<TupleValue>
(via collection's convertForCqlWriter)
+ // - Direct tuple columns: Object[] -> TupleValue
+ // - Collections with tuples: List<Object[]> ->
List<TupleValue> (via collection's convertForCqlWriter)
CqlField field = cqlTable.getField(columnName);
if (field != null && columnValue != null)
{
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
