This is an automated email from the ASF dual-hosted git repository.
jadams pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/daffodil-site.git
The following commit(s) were added to refs/heads/main by this push:
new 714ea1a Stage Daffodil release v3.11.0-rc2
714ea1a is described below
commit 714ea1aeb12d2fc0427cc3761777f3210a9a3555
Author: Josh Adams <jad...@apache.org>
AuthorDate: Fri May 23 16:01:23 2025 +0000
Stage Daffodil release v3.11.0-rc2
---
site/docs/3.11.0/javadoc/index-all.html | 6 +++-
.../org/apache/daffodil/japi/Diagnostic.html | 38 ++++++++++++++++++----
site/docs/3.11.0/scaladoc/index.js | 2 +-
.../org/apache/daffodil/sapi/Diagnostic.html | 4 ++-
4 files changed, 40 insertions(+), 10 deletions(-)
diff --git a/site/docs/3.11.0/javadoc/index-all.html
b/site/docs/3.11.0/javadoc/index-all.html
index fa5392b..ece9bab 100644
--- a/site/docs/3.11.0/javadoc/index-all.html
+++ b/site/docs/3.11.0/javadoc/index-all.html
@@ -359,7 +359,11 @@
<dd> </dd>
<dt><span class="memberNameLink"><a
href="org/apache/daffodil/japi/Diagnostic.html#getMessage--">getMessage()</a></span>
- Method in class org.apache.daffodil.japi.<a
href="org/apache/daffodil/japi/Diagnostic.html" title="class in
org.apache.daffodil.japi">Diagnostic</a></dt>
<dd>
-<div class="block">Get the diagnostic message.</div>
+<div class="block">Get all diagnostic information, including mode name, schema
context, and data location</div>
+</dd>
+<dt><span class="memberNameLink"><a
href="org/apache/daffodil/japi/Diagnostic.html#getMessageOnly--">getMessageOnly()</a></span>
- Method in class org.apache.daffodil.japi.<a
href="org/apache/daffodil/japi/Diagnostic.html" title="class in
org.apache.daffodil.japi">Diagnostic</a></dt>
+<dd>
+<div class="block">Get only the message part of a diagnostic.</div>
</dd>
<dt><span class="memberNameLink"><a
href="org/apache/daffodil/japi/Diagnostic.html#getModeName--">getModeName()</a></span>
- Method in class org.apache.daffodil.japi.<a
href="org/apache/daffodil/japi/Diagnostic.html" title="class in
org.apache.daffodil.japi">Diagnostic</a></dt>
<dd>
diff --git a/site/docs/3.11.0/javadoc/org/apache/daffodil/japi/Diagnostic.html
b/site/docs/3.11.0/javadoc/org/apache/daffodil/japi/Diagnostic.html
index d1876e2..0c9055e 100644
--- a/site/docs/3.11.0/javadoc/org/apache/daffodil/japi/Diagnostic.html
+++ b/site/docs/3.11.0/javadoc/org/apache/daffodil/japi/Diagnostic.html
@@ -17,7 +17,7 @@
catch(err) {
}
//-->
-var methods =
{"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
+var methods =
{"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance
Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@@ -160,34 +160,40 @@ extends java.lang.Object</pre>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/daffodil/japi/Diagnostic.html#getMessage--">getMessage</a></span>()</code>
-<div class="block">Get the diagnostic message.</div>
+<div class="block">Get all diagnostic information, including mode name, schema
context, and data location</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/daffodil/japi/Diagnostic.html#getMessageOnly--">getMessageOnly</a></span>()</code>
+<div class="block">Get only the message part of a diagnostic.</div>
+</td>
+</tr>
+<tr id="i4" class="altColor">
+<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/daffodil/japi/Diagnostic.html#getModeName--">getModeName</a></span>()</code>
<div class="block">Get the diagnostic mode name</div>
</td>
</tr>
-<tr id="i4" class="altColor">
+<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.Throwable</code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/daffodil/japi/Diagnostic.html#getSomeCause--">getSomeCause</a></span>()</code>
<div class="block">Get the cause of that cause this diagnostic</div>
</td>
</tr>
-<tr id="i5" class="rowColor">
+<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/daffodil/japi/Diagnostic.html#getSomeMessage--">getSomeMessage</a></span>()</code>
<div class="block">Get the message that caused this diagnostic</div>
</td>
</tr>
-<tr id="i6" class="altColor">
+<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/daffodil/japi/Diagnostic.html#isError--">isError</a></span>()</code>
<div class="block">Determine if a diagnostic object represents an error or
something less serious.</div>
</td>
</tr>
-<tr id="i7" class="rowColor">
+<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../org/apache/daffodil/japi/Diagnostic.html#toString--">toString</a></span>()</code>
<div class="block">Get a string containing the mode name, message, schema
location, and data location combined
@@ -274,7 +280,25 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>getMessage</h4>
<pre>public java.lang.String getMessage()</pre>
-<div class="block">Get the diagnostic message.
+<div class="block">Get all diagnostic information, including mode name, schema
context, and data location
+ <p>
+ Future versions of Daffodil will change getMessage to return only the message
portion of a
+ diagnostic, matching the behavior of getMessageOnly--users should call
toString() instead.
+ <p></div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>diagnostic message in string form</dd>
+</dl>
+</li>
+</ul>
+<a name="getMessageOnly--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getMessageOnly</h4>
+<pre>public java.lang.String getMessageOnly()</pre>
+<div class="block">Get only the message part of a diagnostic.
<p>
This does not include mode name, schema context, or data location information
<p></div>
diff --git a/site/docs/3.11.0/scaladoc/index.js
b/site/docs/3.11.0/scaladoc/index.js
index 0f57744..9e9da8c 100644
--- a/site/docs/3.11.0/scaladoc/index.js
+++ b/site/docs/3.11.0/scaladoc/index.js
@@ -1 +1 @@
-Index.PACKAGES = {"org.apache.daffodil.runtime1" : [],
"org.apache.daffodil.sapi" : [{"name" : "org.apache.daffodil.sapi.Compiler",
"shortDescription" : "Compile DFDL schemas into ProcessorFactory's or reload
saved parsers into DataProcessor's.", "members_class" : [{"label" :
"withTunables", "tail" : "(tunables: Map[String, String]): Compiler", "member"
: "org.apache.daffodil.sapi.Compiler.withTunables", "link" :
"org\/apache\/daffodil\/sapi\/Compiler.html#withTunables(tunables:Map[Strin
[...]
\ No newline at end of file
+Index.PACKAGES = {"org.apache.daffodil.runtime1" : [],
"org.apache.daffodil.sapi" : [{"name" : "org.apache.daffodil.sapi.Compiler",
"shortDescription" : "Compile DFDL schemas into ProcessorFactory's or reload
saved parsers into DataProcessor's.", "members_class" : [{"label" :
"withTunables", "tail" : "(tunables: Map[String, String]): Compiler", "member"
: "org.apache.daffodil.sapi.Compiler.withTunables", "link" :
"org\/apache\/daffodil\/sapi\/Compiler.html#withTunables(tunables:Map[Strin
[...]
\ No newline at end of file
diff --git a/site/docs/3.11.0/scaladoc/org/apache/daffodil/sapi/Diagnostic.html
b/site/docs/3.11.0/scaladoc/org/apache/daffodil/sapi/Diagnostic.html
index a3939ef..6277bc4 100644
--- a/site/docs/3.11.0/scaladoc/org/apache/daffodil/sapi/Diagnostic.html
+++ b/site/docs/3.11.0/scaladoc/org/apache/daffodil/sapi/Diagnostic.html
@@ -154,7 +154,9 @@ an infoset. A new InfosetOutputter is required for each
call to unparse().
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a
href="index.html" name="org.apache.daffodil.sapi" id="org.apache.daffodil.sapi"
class="extype">sapi</a></dd></dl></div></li><li class="indented5 "
name="org.apache.daffodil.sapi.io" group="Ungrouped" fullComment="yes"
data-isabs="false" visbl="pub"><a id="io" class="anchorToMember"></a><a
id="io:io" class="anchorToMember"></a> <span class="permalink"><a
href="../../../../org/apache/daffodil/sapi/io/index.html" title [...]
</p></div><div class="toggleContainer"><div class="toggle block"><span>Linear
Supertypes</span><div class="superTypes hiddenContent"><span
name="scala.AnyRef" class="extype">AnyRef</span>, <span name="scala.Any"
class="extype">Any</span></div></div></div></div><div id="mbrsel"><div
class="toggle"></div><div id="memberfilter"><i class="material-icons
arrow"></i><span class="input"><input placeholder="Filter all members"
id="mbrsel-input" type="text" accesskey="/"/></span><i class="clear [...]
</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>list
of <a href="DataLocation.html" name="org.apache.daffodil.sapi.DataLocation"
id="org.apache.daffodil.sapi.DataLocation" class="extype">DataLocation</a>'s
related to this diagnostic</p></dd></dl></div></li><li class="indented0 "
name="org.apache.daffodil.sapi.Diagnostic#getLocationsInSchemaFiles"
group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a
id="getLocationsInSchemaFiles:Seq[org.apache.daf [...]
-</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>list
of <a href="LocationInSchemaFile.html"
name="org.apache.daffodil.sapi.LocationInSchemaFile"
id="org.apache.daffodil.sapi.LocationInSchemaFile"
class="extype">LocationInSchemaFile</a>'s related to this
diagnostic.</p></dd></dl></div></li><li class="indented0 "
name="org.apache.daffodil.sapi.Diagnostic#getMessage" group="Ungrouped"
fullComment="yes" data-isabs="false" visbl="pub"><a id="getMessage():String"
class [...]
+</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>list
of <a href="LocationInSchemaFile.html"
name="org.apache.daffodil.sapi.LocationInSchemaFile"
id="org.apache.daffodil.sapi.LocationInSchemaFile"
class="extype">LocationInSchemaFile</a>'s related to this
diagnostic.</p></dd></dl></div></li><li class="indented0 "
name="org.apache.daffodil.sapi.Diagnostic#getMessage" group="Ungrouped"
fullComment="yes" data-isabs="false" visbl="pub"><a id="getMessage():String"
class [...]
+diagnostic, matching the behavior of getMessageOnly--users should call
toString() instead.
+</p></div><dl class="paramcmts block"><dt>returns</dt><dd
class="cmt"><p>diagnostic message in string form</p></dd></dl></div></li><li
class="indented0 " name="org.apache.daffodil.sapi.Diagnostic#getMessageOnly"
group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a
id="getMessageOnly():String" class="anchorToMember"></a> <span
class="permalink"><a
href="../../../../org/apache/daffodil/sapi/Diagnostic.html#getMessageOnly():String"
title="Permalink"><i class="material-icons [...]
</p></div><dl class="paramcmts block"><dt>returns</dt><dd
class="cmt"><p>diagnostic message in string form</p></dd></dl></div></li><li
class="indented0 " name="org.apache.daffodil.sapi.Diagnostic#getModeName"
group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a
id="getModeName():String" class="anchorToMember"></a> <span
class="permalink"><a
href="../../../../org/apache/daffodil/sapi/Diagnostic.html#getModeName():String"
title="Permalink"><i class="material-icons"></i></ [...]
</p><div class="fullcomment"><div class="comment cmt"><p>Get the diagnostic
mode name
</p></div><dl class="paramcmts block"><dt>returns</dt><dd
class="cmt"><p>diagnostic mode name in string form</p></dd></dl></div></li><li
class="indented0 " name="org.apache.daffodil.sapi.Diagnostic#getSomeCause"
group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a
id="getSomeCause:Throwable" class="anchorToMember"></a> <span
class="permalink"><a
href="../../../../org/apache/daffodil/sapi/Diagnostic.html#getSomeCause:Throwable"
title="Permalink"><i class="material-icons"> [...]
