You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2026/06/17 11:56:29 UTC
(juneau) branch docs updated: refactor(marshall): rename text-format Proto codec to Prototext (binary stays Protobuf); de-flake PetstoreJetty_Test request timeouts
This is an automated email from the ASF dual-hosted git repository.
jamesbognar pushed a commit to branch docs
in repository https://gitbox.apache.org/repos/asf/juneau.git
The following commit(s) were added to refs/heads/docs by this push:
new 624834ba13 refactor(marshall): rename text-format Proto codec to Prototext (binary stays Protobuf); de-flake PetstoreJetty_Test request timeouts
624834ba13 is described below
commit 624834ba134ac4e8b1146e377970dfdf88375c29
Author: James Bognar <ja...@apache.org>
AuthorDate: Wed Jun 17 07:56:21 2026 -0400
refactor(marshall): rename text-format Proto codec to Prototext (binary stays Protobuf); de-flake PetstoreJetty_Test request timeouts
---
pages/release-notes/10.0.0.md | 2 +-
pages/topics/02.34.05.ProtobufBasics.md | 20 ++++++++++----------
pages/topics/02.50.02.RecordStreaming.md | 2 +-
pages/topics/02.50.04.ArrayRecordStreaming.md | 2 +-
static/ai/juneau-knowledge.jsonl | 2 +-
5 files changed, 14 insertions(+), 14 deletions(-)
diff --git a/pages/release-notes/10.0.0.md b/pages/release-notes/10.0.0.md
index 98ecfd34e3..f9d95a68cd 100644
--- a/pages/release-notes/10.0.0.md
+++ b/pages/release-notes/10.0.0.md
@@ -331,7 +331,7 @@ Both `MarshalledNode` and `JsonPointer` are marked **Beta — API subject to cha
#### Protobuf binary wire-format codec
Juneau 10.0 adds a native, bean-driven **Protocol Buffers binary** serializer and parser in the new
-`org.apache.juneau.marshall.protobuf` package — distinct from the existing text-format `marshall.proto`
+`org.apache.juneau.marshall.protobuf` package — distinct from the existing text-format `marshall.prototext`
codec (`text/protobuf`). It emits the compact, non-self-describing protobuf binary wire format used by
`protoc`-generated code, with **no `.proto` schema file or code generation required**: the
field-number/type schema is derived directly from Juneau bean metadata.
diff --git a/pages/topics/02.34.05.ProtobufBasics.md b/pages/topics/02.34.05.ProtobufBasics.md
index 1f1fdef433..c395b63c4a 100644
--- a/pages/topics/02.34.05.ProtobufBasics.md
+++ b/pages/topics/02.34.05.ProtobufBasics.md
@@ -3,7 +3,7 @@ title: "Protobuf Text Format Basics"
slug: ProtobufBasics
---
-Juneau supports converting arbitrary POJOs to and from the **Protobuf Text Format** using native serializers and parsers implemented without any external dependencies. This is the human-readable text format (not the binary wire format) used for protobuf configuration files, debugging, and interop with tools like `protoc --decode`. The <a href="/site/apidocs/org/apache/juneau/marshall/proto/ProtoSerializer.html" target="_blank">ProtoSerializer</a> converts POJOs directly to Protobuf Text [...]
+Juneau supports converting arbitrary POJOs to and from the **Protobuf Text Format** using native serializers and parsers implemented without any external dependencies. This is the human-readable text format (not the binary wire format) used for protobuf configuration files, debugging, and interop with tools like `protoc --decode`. The <a href="/site/apidocs/org/apache/juneau/marshall/prototext/PrototextSerializer.html" target="_blank">PrototextSerializer</a> converts POJOs directly to Pr [...]
**No `.proto` schema files are required**—Java bean metadata provides the type information.
@@ -24,7 +24,7 @@ Protobuf Text Format support is included in `juneau-marshall`:
```java
// Serialize a bean to Protobuf Text Format
Person p = new Person("Alice", 30);
-String proto = Proto.of(p);
+String proto = Prototext.of(p);
```
Produces:
@@ -38,20 +38,20 @@ age: 30
```java
// Parse Protobuf Text Format into a bean
-Person parsed = Proto.to(proto, Person.class);
+Person parsed = Prototext.to(proto, Person.class);
// Parse into a Map or JsonMap
-JsonMap map = Proto.to(proto, JsonMap.class);
+JsonMap map = Prototext.to(proto, JsonMap.class);
```
##### Serialization
```java
// Use the default serializer
-String proto = ProtoSerializer.DEFAULT.serialize(someObject);
+String proto = PrototextSerializer.DEFAULT.serialize(someObject);
// Use the marshaller for convenience
-String proto = Proto.of(someObject);
+String proto = Prototext.of(someObject);
```
##### Bean-to-Protobuf Mapping
@@ -70,8 +70,8 @@ The conversion follows the <a href="https://protobuf.dev/reference/protobuf/text
##### Annotations
-- **`@Proto`** - Add a comment above a field in the serialized output
-- **`@ProtoConfig`** - Class-level: `useListSyntaxForBeans`, `useColonForMessages`
+- **`@Prototext`** - Add a comment above a field in the serialized output
+- **`@PrototextConfig`** - Class-level: `useListSyntaxForBeans`, `useColonForMessages`
##### Media Types
@@ -81,9 +81,9 @@ The conversion follows the <a href="https://protobuf.dev/reference/protobuf/text
##### REST Integration
```java
-// Use BasicProtoConfig for Protobuf-only REST resources
+// Use BasicPrototextConfig for Protobuf-only REST resources
@Rest
-public class MyResource extends RestServlet implements BasicProtoConfig { ... }
+public class MyResource extends RestServlet implements BasicPrototextConfig { ... }
// Protobuf is also included in BasicUniversalConfig
@Rest
diff --git a/pages/topics/02.50.02.RecordStreaming.md b/pages/topics/02.50.02.RecordStreaming.md
index ea95289660..52b81a7926 100644
--- a/pages/topics/02.50.02.RecordStreaming.md
+++ b/pages/topics/02.50.02.RecordStreaming.md
@@ -93,7 +93,7 @@ if (parser instanceof RecordReadable p) {
- **CSV / JSONL / SSE** — naturally row/line/event streamed; `parseRecords` is the multi-record cursor.
- **JsonSchema / JCS / SOAP-XML** — writer-only; `serializeRecords(output).write(value)` produces the schema / canonical / SOAP-wrapped output. No `parseRecords`.
- **PlainText** — only round-trips strings via `toString()`. `parseRecords(input).read(String.class)` returns the body verbatim.
-- **CBOR / MsgPack / BSON / Proto / Parquet** — binary; pass an `OutputStream` / `byte[]` / `InputStream` instead of a `Writer` / `Reader`.
+- **CBOR / MsgPack / BSON / Prototext / Parquet** — binary; pass an `OutputStream` / `byte[]` / `InputStream` instead of a `Writer` / `Reader`.
##### See also
diff --git a/pages/topics/02.50.04.ArrayRecordStreaming.md b/pages/topics/02.50.04.ArrayRecordStreaming.md
index ccd88dc30a..dff696226a 100644
--- a/pages/topics/02.50.04.ArrayRecordStreaming.md
+++ b/pages/topics/02.50.04.ArrayRecordStreaming.md
@@ -53,7 +53,7 @@ try (RecordWriter w = JsonSerializer.DEFAULT.serializeArrayRecords(output)) {
| XML / HTML | buffered with caller-specified root | not supported (reader only) | Reader has the `parseArrayRecords(input, "rootElementName")` overload; there is no array-record writer. |
| JSONL | streaming | streaming | `arrayRecords` aliases the JSONL line record stream — each top-level line is one element, written/read without a surrounding `[...]`. O(1) memory per element. |
| CSV / SSE | n/a | n/a | Use `parseRecords`/`serializeRecords` — format is already row-streamed. |
-| TOML / HOCON / Hjson / INI / PlainText / Markdown / JsonSchema / JCS / Proto | not supported | not supported | |
+| TOML / HOCON / Hjson / INI / PlainText / Markdown / JsonSchema / JCS / Prototext | not supported | not supported | |
##### Length-prefixed writers (MsgPack count overload)
diff --git a/static/ai/juneau-knowledge.jsonl b/static/ai/juneau-knowledge.jsonl
index f576c6e391..0e438e74b8 100644
--- a/static/ai/juneau-knowledge.jsonl
+++ b/static/ai/juneau-knowledge.jsonl
@@ -200,7 +200,7 @@
{"description": "The <a href=\"/site/apidocs/org/apache/juneau/marshall/oapi/OpenApiSerializer.html\" target=\"_blank\">OpenApiSerializer</a> class is used to convert POJOs to\nHTTP parts.\n\nThe class hierarchy for the builder of this serializer is:\n\n<tree>\n<node-0><java-abstract-class><a href=\"/site/apidocs/org/apache/juneau/Context.Builder.html\" target=\"_blank\">Context.Builder</a></java-abstract-class></node-0>\n<node-1><java-abstract-class><a href=\"/site/apidocs/org/apache/ju [...]
{"description": "The <a href=\"/site/apidocs/org/apache/juneau/marshall/oapi/OpenApiParser.html\" target=\"_blank\">OpenApiParser</a> class is used to convert HTTP parts back\ninto POJOs.\n\nThe class hierarchy for the builder of this parser is:\n\n<tree>\n<node-0><java-abstract-class><a href=\"/site/apidocs/org/apache/juneau/Context.Builder.html\" target=\"_blank\">Context.Builder</a></java-abstract-class></node-0>\n<node-1><java-abstract-class><a href=\"/site/apidocs/org/apache/juneau/ [...]
{"description": "Juneau supports converting arbitrary POJOs to and from TOML (Tom's Obvious Minimal Language) using native serializers and parsers implemented without any external dependencies.\nTOML is a configuration file format that maps unambiguously to hash tables, widely used in projects like Cargo (Rust) and Python's `pyproject.toml`.\nThe <a href=\"/site/apidocs/org/apache/juneau/marshall/toml/TomlSerializer.html\" target=\"_blank\">TomlSerializer</a> converts POJOs directly to T [...]
-{"description": "Juneau supports converting arbitrary POJOs to and from the **Protobuf Text Format** using native serializers and parsers implemented without any external dependencies. This is the human-readable text format (not the binary wire format) used for protobuf configuration files, debugging, and interop with tools like `protoc --decode`. The <a href=\"/site/apidocs/org/apache/juneau/marshall/proto/ProtoSerializer.html\" target=\"_blank\">ProtoSerializer</a> converts POJOs direc [...]
+{"description": "Juneau supports converting arbitrary POJOs to and from the **Protobuf Text Format** using native serializers and parsers implemented without any external dependencies. This is the human-readable text format (not the binary wire format) used for protobuf configuration files, debugging, and interop with tools like `protoc --decode`. The <a href=\"/site/apidocs/org/apache/juneau/marshall/prototext/PrototextSerializer.html\" target=\"_blank\">PrototextSerializer</a> converts [...]
{"description": "The `org.apache.juneau.marshall.parquet` package provides Juneau serializer and parser implementations for the\n[Apache Parquet](https://parquet.apache.org/docs/file-format/) columnar storage format.\n\nThe `ParquetSerializer` and `ParquetParser` classes integrate with the standard Juneau\n`Serializer` / `Parser` APIs and support the `@Parquet` and `@ParquetConfig` annotations for\nformat-specific configuration.\n\n:::note\nFull documentation for the Parquet serializer/p [...]
{"description": "Juneau supports converting arbitrary POJOs to and from YAML using native serializers and parsers implemented\nwithout any external dependencies.\nThe YAML serializer converts POJOs directly to YAML block-style output using indentation-based structure.\nThe YAML parser creates POJOs directly from YAML using an indentation-aware state machine.\n\nThe following example shows YAML for a typical bean:\n\n##### Sample Beans\n\n```java\npublic class Person {\n\n // Bean prop [...]
{"description": "The YAML data type produced depends on the Java object type being serialized.\n\n- Primitives and primitive objects are converted to YAML scalars.\n- Beans and `Maps` are converted to YAML block mappings.\n- `Collections` and arrays are converted to YAML block sequences.\n- Anything else is converted to YAML string scalars (with quoting if necessary).\n\n##### Data type conversions:\n\n| POJO type | YAML type | Example | Serialized form |\n|-----------|-----------|------ [...]