Skip to content

Commit fea3aa2

Browse files
dfa1claude
andcommitted
fix(javadoc): repair broken cross-references from in-flight migration
- VortexHttpReader: [#slice] → [#rawSegment] (method renamed) - ArrayNode/UnknownArrayNode: qualify ReadRegistry#isAllowUnknown fully - BoolEncodingDecoder/Encoder: drop stale ADR phase comments - Chunk: drop Extension#decodeAll (Extension deleted) - VortexHandle: fix FlatSegmentDecoder package (moved to reader) - NullableData: drop MaskedArray#inner cross-module link - CascadingCompressor: fix EncodeContext#ofDepth signature - VortexWriter: drop [Encoding] class ref (class removed) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 558fcaa commit fea3aa2

10 files changed

Lines changed: 10 additions & 17 deletions

File tree

‎reader/src/main/java/io/github/dfa1/vortex/reader/Chunk.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ public <T extends Array> T column(String name) {
9191

9292
/// Decodes an extension column into a typed `List<T>` of domain values.
9393
///
94-
/// Hides the {@link Extension#decodeAll} boilerplate for the four spec extensions:
94+
/// Hides extension-decode boilerplate for the four spec extensions:
9595
///
9696
/// ```java
9797
/// List<LocalDate> dates = chunk.as("birthdays", LocalDate.class);

‎reader/src/main/java/io/github/dfa1/vortex/reader/VortexHandle.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public interface VortexHandle extends Closeable {
4949
///
5050
/// <p><strong>Internal escape hatch.</strong> Exposed for tooling
5151
/// (e.g. the inspector's dictionary preview) that needs to decode an
52-
/// internal subtree node directly via {@link io.github.dfa1.vortex.encoding.FlatSegmentDecoder}.
52+
/// internal subtree node directly via {@link io.github.dfa1.vortex.reader.FlatSegmentDecoder}.
5353
/// Not part of the supported stability contract; signatures may change
5454
/// without deprecation.
5555
///

‎reader/src/main/java/io/github/dfa1/vortex/reader/VortexHttpReader.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
/// Handle to a remote Vortex file read via HTTP Range requests.
1919
///
2020
/// On open: fetches the last [#TAIL_SIZE] bytes to locate the trailer, postscript,
21-
/// and metadata blobs (footer, layout, dtype). Each [#slice] call fires a targeted
21+
/// and metadata blobs (footer, layout, dtype). Each [#rawSegment] call fires a targeted
2222
/// Range request; no full-file download occurs.
2323
///
2424
/// All allocated buffers (segment bytes and encoding outputs) share a single

‎reader/src/main/java/io/github/dfa1/vortex/reader/decode/ArrayNode.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
///
1010
/// Sealed: a node is either [KnownArrayNode] (id resolves to an [EncodingId]) or
1111
/// [UnknownArrayNode] (id is an arbitrary string only meaningful for
12-
/// {@link ReadRegistry#isAllowUnknown()} passthrough decode).
12+
/// {@link io.github.dfa1.vortex.reader.ReadRegistry#isAllowUnknown()} passthrough decode).
1313
public sealed interface ArrayNode permits KnownArrayNode, UnknownArrayNode {
1414

1515
/// Short factory for the common case: a node whose encoding id is well-known.

‎reader/src/main/java/io/github/dfa1/vortex/reader/decode/BoolEncodingDecoder.java‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,7 @@
77

88
/// Read-only decoder for {@code vortex.bool} (bit-packed boolean arrays, LSB first).
99
///
10-
/// <p>ADR 0001 Phase 2: first encoding lifted into a standalone {@link EncodingDecoder}
11-
/// implementation in the {@code reader} module. The corresponding write-side encode
12-
/// path continues to live on {@link io.github.dfa1.vortex.encoding.BoolEncoding} in
13-
/// {@code core}; that file is peeled into a {@code BoolEncodingEncoder} in
14-
/// {@code writer} during Phase 3.
10+
/// Read-only decoder for bit-packed boolean arrays.
1511
public final class BoolEncodingDecoder implements EncodingDecoder {
1612

1713
/// Public no-arg constructor required by {@link java.util.ServiceLoader}.

‎reader/src/main/java/io/github/dfa1/vortex/reader/decode/UnknownArrayNode.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
/// Array node whose encoding id is not a recognised {@link io.github.dfa1.vortex.encoding.EncodingId}.
66
/// Produced when a file uses an encoding this build does not know about. Decoded as
77
/// {@link io.github.dfa1.vortex.reader.array.UnknownArray} when
8-
/// {@link ReadRegistry#isAllowUnknown()} is set; otherwise the decode call throws.
8+
/// {@link io.github.dfa1.vortex.reader.ReadRegistry#isAllowUnknown()} is set; otherwise the decode call throws.
99
///
1010
/// @param rawEncodingId the raw encoding id string from the file
1111
/// @param metadata encoding-specific metadata bytes, or {@code null}

‎writer/src/main/java/io/github/dfa1/vortex/writer/VortexWriter.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,7 @@ private static ByteBuffer buildPostscript(
323323

324324
// ── Segment encoding ─────────────────────────────────────────────────────
325325

326-
/// Write one chunk. Each column is encoded by the first registered [Encoding] that accepts its dtype.
326+
/// Write one chunk. Each column is encoded by the first registered encoder that accepts its dtype.
327327
///
328328
/// @param columns map from column name to typed array data
329329
/// @throws IOException if an I/O error occurs writing to the underlying channel

‎writer/src/main/java/io/github/dfa1/vortex/writer/encode/BoolEncodingEncoder.java‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,7 @@
1010

1111
/// Write-only encoder for {@code vortex.bool} (bit-packed boolean arrays, LSB first).
1212
///
13-
/// <p>ADR 0001 Phase 3: first encoding lifted into a standalone {@link EncodingEncoder}
14-
/// implementation in the {@code writer} module. The corresponding read-side decode path
15-
/// lives on {@link io.github.dfa1.vortex.reader.decode.BoolEncodingDecoder} in
16-
/// {@code reader}.
13+
/// Write-side encoder for {@code vortex.bool}.
1714
public final class BoolEncodingEncoder implements EncodingEncoder {
1815

1916
/// Public no-arg constructor required by {@link java.util.ServiceLoader}.

‎writer/src/main/java/io/github/dfa1/vortex/writer/encode/CascadingCompressor.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ private static long primitiveBytes(DType dtype, int n) {
6666
/// Entry point: encode {@code data} using the best cascading strategy.
6767
///
6868
/// <p>Cascade parameters (depth, sampling, exclusions) are taken from {@code ctx}.
69-
/// Use {@link EncodeContext#ofDepth(int, java.lang.foreign.Arena, java.util.Map)}
69+
/// Use {@link EncodeContext#ofDepth(int, java.lang.foreign.Arena, WriteRegistry)}
7070
/// to build a context with cascade depth set.
7171
///
7272
/// @param dtype the logical type of the data to encode

‎writer/src/main/java/io/github/dfa1/vortex/writer/encode/NullableData.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
///
1616
/// <p>Invariant: {@code values} length (or storage row count) matches
1717
/// {@code validity.length}; placeholders at null positions must be zero so the
18-
/// {@link MaskedArray#inner()} child contains no semantic nulls.
18+
/// the validity child contains no semantic nulls.
1919
///
2020
/// @param values packed values array; concrete type depends on the column dtype
2121
/// @param validity per-row validity bitmap, parallel to {@code values}

0 commit comments

Comments
 (0)