Skip to content

Commit

Permalink
doc-files fixes and modernization
Browse files Browse the repository at this point in the history 
Signed-off-by: Nicola Isotta <[email protected]>
  • Loading branch information
@NicolaIsotta @ThePrez
NicolaIsotta authored and ThePrez committed Feb 1, 2024
1 parent a47a446 commit 8c4ae13
Show file tree
Hide file tree
Showing 23 changed files with 501 additions and 502 deletions.
3 changes: 1 addition & 2 deletions pom-dist.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -837,13 +837,12 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.6.0</version>
<version>3.6.3</version>
<configuration>
<encoding>UTF-8</encoding>
<sourcepath>${basedir}/target/sources_java8</sourcepath>
<additionalOptions>-html4 -Xmaxwarns 1</additionalOptions>
<docfilessubdirs>true</docfilessubdirs>
<doclint>none</doclint>
</configuration>
<executions>
<execution>
Expand Down
4 changes: 2 additions & 2 deletions src/main/javadoc/com/ibm/as400/access/doc-files/AFPResourceAttrs.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML lang="en">
<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<title>IBM Toolbox for Java: AFP Resource Attributes </title>
Expand Down
98 changes: 49 additions & 49 deletions src/main/javadoc/com/ibm/as400/access/doc-files/JDBCProperties.html
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!DOCTYPE html PUBLIC "-//w3c//dtd html 3.2 final//en">
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML lang="en">
<HEAD>
<TITLE>IBM Toolbox for Java: JDBC properties</TITLE>
Expand Down Expand Up @@ -40,7 +40,7 @@ <h3>General properties</h3>
<p>General properties are system attributes that specify the user, password, and
whether a prompt is necessary to connect to the system.</p>

<TABLE BORDER="1">
<TABLE BORDER="1" SUMMARY="General properties">
<TR VALIGN="bottom" CLASS="hilightbar">
<TH ID="cat1">General property</TH>
<TH ID="cat1t2">Description</TH>
Expand Down Expand Up @@ -103,7 +103,7 @@ <h3>General properties</h3>
<h3>System properties</h3>
<p>System properties specify attributes that govern transactions, libraries, and
databases.</p>
<TABLE BORDER="1">
<TABLE BORDER="1" SUMMARY="System properties">
<TR VALIGN="bottom" CLASS="hilightbar">
<TH ID="cat2">System property</TH>
<TH ID="cat2t2">Description</TH>
Expand All @@ -112,7 +112,7 @@ <h3>System properties</h3>
<TH ID="cat2t5">Default</TH>
</TR>
<TR VALIGN="TOP">
<TD HEADERS="cat2"><a name="auto commit">&quot;auto commit&quot;</a></TD>
<TD HEADERS="cat2"><a name="autocommit">&quot;auto commit&quot;</a></TD>
<TD HEADERS="cat2t2">Specifies whether auto-commit mode is the default connection
mode for new connections. Calling AS400JDBCConnection.setAutoCommit(boolean)
will override this property on a per-connection basis. Note that, in order
Expand Down Expand Up @@ -148,7 +148,7 @@ <h3>System properties</h3>
</TR>
<TR VALIGN="TOP">
<TD HEADERS="cat2"><a name="cursorsensitivity">&quot;cursor sensitivity&quot;</a></TD>
<TD HEADERS="cat2t2"><p></p>Specifies the cursor sensitivity to request from the database. The behavior
<TD HEADERS="cat2t2"><p>Specifies the cursor sensitivity to request from the database. The behavior
depends on the resultSetType:</p>
<ul>
<li>ResultSet.TYPE_FORWARD_ONLY or ResultSet.TYPE_SCROLL_SENSITIVE means that
Expand Down Expand Up @@ -362,7 +362,7 @@ <h3>System properties</h3>
<h3>Format properties</h3>
<p>Format properties specify date and time formats, date and decimal separators,
and table naming conventions used within SQL statements.</p>
<TABLE BORDER="1">
<TABLE BORDER="1" SUMMARY="Format properties">
<TR VALIGN="bottom" CLASS="hilightbar">
<TH ID="cat3">Format property</TH>
<TH ID="cat3t2">Description</TH>
Expand Down Expand Up @@ -442,7 +442,7 @@ <h3>Format properties</h3>
<h3>Performance properties</h3>
<p>Performance properties are attributes that include caching, data conversion,
data compression, and prefetching that affect performance.</p>
<TABLE BORDER="1">
<TABLE BORDER="1" SUMMARY="Performance properties">
<TR VALIGN="bottom" CLASS="hilightbar">
<TH ID="cat4">Performance property</TH>
<TH ID="cat4t2">Description</TH>
Expand Down Expand Up @@ -725,7 +725,7 @@ <h3>Performance properties</h3>
<A NAME="sort"></A>
<h3>Sort properties</h3>
<p>Sort properties specify how the system performs stores and performs sorts.</p>
<TABLE BORDER="1">
<TABLE BORDER="1" SUMMARY="Sort properties">
<TR VALIGN="bottom" CLASS="hilightbar">
<TH ID="cat5">Sort property</TH>
<TH ID="cat5t2">Description</TH>
Expand Down Expand Up @@ -829,7 +829,7 @@ <h3>Alternate server properties</h3>
preserve those setting that are changed
using other methods, including a stored procedure call.</p>

<TABLE BORDER="1">
<TABLE BORDER="1" SUMMARY="Alternate server properties">
<TR VALIGN="bottom" CLASS="hilightbar">
<TH ID="cat7">Property</TH>
<TH ID="cat7t2">Description</TH>
Expand Down Expand Up @@ -943,10 +943,10 @@ <h3>Alternate server properties</h3>
not throw an SQLException with SQL error code -4498 after a failed connection has
been successfully re-established if the following conditions are true:</p>
<ul>
<li>The connection was not being used for a transaction at the time the failure occurred.</p>
<li>The connection was not being used for a transaction at the time the failure occurred.</li>
<li>There are no outstanding global resources, such as global temporary tables or
open, held cursors, or connection states that prevent a seamless failover to another
server.</p>
server.</li>
</ul>
<p>When seamless failover occurs, after the connection to a new server has been
established, the driver re-issues the SQL statement that was being processed when
Expand Down Expand Up @@ -975,48 +975,48 @@ <h3>Alternate server properties</h3>
<h3>Network properties</h3>
<p>Network properties control the behavior of the TCP/IP connection to the server</p>

<TABLE BORDER="1">
<TABLE BORDER="1" SUMMARY="Network properties">
<TR VALIGN="bottom" CLASS="hilightbar">
<TH ID="cat6">Other property</TH>
<TH ID="cat6t2">Description</TH>
<TH ID="cat6t3">Required</TH>
<TH ID="cat6t4">Choices</TH>
<TH ID="cat6t5">Default</TH>
<TH ID="cat8">Network property</TH>
<TH ID="cat8t2">Description</TH>
<TH ID="cat8t3">Required</TH>
<TH ID="cat8t4">Choices</TH>
<TH ID="cat8t5">Default</TH>
</TR>



<TR VALIGN="TOP">
<TD HEADERS="cat4">&quot;login timeout&quot;</TD>
<TD HEADERS="cat4t2">The login timeout specifies the number of milliseconds that the JDBC driver
<TD HEADERS="cat8">&quot;login timeout&quot;</TD>
<TD HEADERS="cat8t2">The login timeout specifies the number of milliseconds that the JDBC driver
will wait for a new socket to the database host server to be established. A value of zero indicates that JDBC
driver will wait indefinitely for the socket to be established.</TD>
<TD HEADERS="cat4t3" ALIGN="CENTER">no</TD>
<TD HEADERS="cat4t4">&quot;0&quot; (no timeout)</TD>
<TD HEADERS="cat4t5">&quot;0&quot;</TD>
<TD HEADERS="cat8t3" ALIGN="CENTER">no</TD>
<TD HEADERS="cat8t4">&quot;0&quot; (no timeout)</TD>
<TD HEADERS="cat8t5">&quot;0&quot;</TD>
</TR>

<TR VALIGN="TOP">
<TD HEADERS="cat4">&quot;receive buffer size&quot;</TD>
<TD HEADERS="cat4t2">Specifies the buffer size used to receive data through the socket connection
<TD HEADERS="cat8">&quot;receive buffer size&quot;</TD>
<TD HEADERS="cat8t2">Specifies the buffer size used to receive data through the socket connection
between the front-end driver and the IBM i system. <br>NOTE: This does not specify the actual receive buffer size.
It is only used as a hint by the underlying socket code.</TD>
<TD HEADERS="cat4t3" ALIGN="CENTER">no</TD>
<TD HEADERS="cat4t4">&quot;1&quot; (max size)</TD>
<TD HEADERS="cat4t5">(platform dependent)</TD>
<TD HEADERS="cat8t3" ALIGN="CENTER">no</TD>
<TD HEADERS="cat8t4">&quot;1&quot; (max size)</TD>
<TD HEADERS="cat8t5">(platform dependent)</TD>
</TR>
<TR VALIGN="TOP">
<TD HEADERS="cat4">&quot;send buffer size&quot;</TD>
<TD HEADERS="cat4t2">Specifies the buffer size used to send data through the socket connection
<TD HEADERS="cat8">&quot;send buffer size&quot;</TD>
<TD HEADERS="cat8t2">Specifies the buffer size used to send data through the socket connection
between the front-end driver and the IBM i system. <br>NOTE: This does not specify the
actual send buffer size. It is only used as a hint by the underlying socket code.</TD>
<TD HEADERS="cat4t3" ALIGN="CENTER">no</TD>
<TD HEADERS="cat4t4">&quot;1&quot; (max size)</TD>
<TD HEADERS="cat4t5">(platform dependent)</TD>
<TD HEADERS="cat8t3" ALIGN="CENTER">no</TD>
<TD HEADERS="cat8t4">&quot;1&quot; (max size)</TD>
<TD HEADERS="cat8t5">(platform dependent)</TD>
</TR>
<TR VALIGN="TOP">
<TD HEADERS="cat4">&quot;socket timeout&quot;</TD>
<TD HEADERS="cat4t2">Sets the millisecond timeout used by the network socket.
<TD HEADERS="cat8">&quot;socket timeout&quot;</TD>
<TD HEADERS="cat8t2">Sets the millisecond timeout used by the network socket.
This determines the maximum number of milliseconds a JDBC connection will block on a read operation
while waiting for a server response.
<br>NOTE1: If the timeout occurs, then the connection becomes unusable.
Expand All @@ -1027,20 +1027,20 @@ <h3>Network properties</h3>
server response, and a connection idle longer than the socket timeout will drop the connection.

</TD>
<TD HEADERS="cat4t3" ALIGN="CENTER">no</TD>
<TD HEADERS="cat4t4">&quot;0&quot; (no timeout)</TD>
<TD HEADERS="cat4t5">&quot;0&quot;</TD>
<TD HEADERS="cat8t3" ALIGN="CENTER">no</TD>
<TD HEADERS="cat8t4">&quot;0&quot; (no timeout)</TD>
<TD HEADERS="cat8t5">&quot;0&quot;</TD>
</TR>

<TR VALIGN="TOP">
<TD HEADERS="cat4">&quot;tcp no delay&quot;</TD>
<TD HEADERS="cat4t2">Sets the TCP no delay used by the network socket. To minimize response time, this
<TD HEADERS="cat8">&quot;tcp no delay&quot;</TD>
<TD HEADERS="cat8t2">Sets the TCP no delay used by the network socket. To minimize response time, this
should be set to true on Windows systems that use Nagle's algorithm to reduce network load.

</TD>
<TD HEADERS="cat4t3" ALIGN="CENTER">no</TD>
<TD HEADERS="cat4t4">&quot;true<br>false&quot; (no timeout)</TD>
<TD HEADERS="cat4t5">&quot;false&quot;</TD>
<TD HEADERS="cat8t3" ALIGN="CENTER">no</TD>
<TD HEADERS="cat8t4">&quot;true<br>false&quot; (no timeout)</TD>
<TD HEADERS="cat8t5">&quot;false&quot;</TD>
</TR>


Expand All @@ -1054,7 +1054,7 @@ <h3>Other properties</h3>
<p>Other properties are those properties not easily categorized. These properties
determine which JDBC driver is used, and specify options related to level of
database access, bidirectional string type, data truncation and so on.</p>
<TABLE BORDER="1">
<TABLE BORDER="1" SUMMARY="Other properties">
<TR VALIGN="bottom" CLASS="hilightbar">
<TH ID="cat6">Other property</TH>
<TH ID="cat6t2">Description</TH>
Expand Down Expand Up @@ -1306,23 +1306,23 @@ <h3>Other properties</h3>
<TD HEADERS="cat6t5">&quot;0&quot; (V6R1 and earlier) &quot;1&quot; (post V6R1)</TD>
</TR>

: <TR VALIGN="TOP">
<TR VALIGN="TOP">
<TD HEADERS="cat6"><a name="numericrangeerror">&quot;numeric range error&quot;</a></TD>
<TD HEADERS="cat6t2">
<p>Specifies how numeric range errors are handled. Possible values are the following.
<p>Specifies how numeric range errors are handled. Possible values are the following.</p>
<ul>
<li>default -- A numeric range error that occurs when writing to the database
always throws an error. A numeric range error that occurs when processing a
query always posts a warning. When a warning occurs, the maximum possible
numeric value is sent for overflow and the minimum possible numeric value
is sent for underflow.
is sent for underflow.</li>
<li>warning -- A numeric range error always posts a warning.
When a warning occurs, the maximum possible numeric value is sent for
overflow and the minimum possible numeric value is sent for underflow.
overflow and the minimum possible numeric value is sent for underflow.</li>
<li> none -- No warnings or errors are reported for numeric range error.
The maximum possible numeric value is sent for overflow and the
minimum possible numeric value is sent for underflow.
</p>
minimum possible numeric value is sent for underflow.</li>
</ul>
</TD>
<TD HEADERS="cat6t3" ALIGN="CENTER">no</TD>
<TD HEADERS="cat6t4">&quot;true&quot;<BR>
Expand Down
4 changes: 2 additions & 2 deletions src/main/javadoc/com/ibm/as400/access/doc-files/LDRWExample.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML lang="en">
<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<TITLE>IBM Toolbox for Java Example: Using LineDataRecordWriter</TITLE>
Expand Down
4 changes: 2 additions & 2 deletions src/main/javadoc/com/ibm/as400/access/doc-files/OutputQueueAttrs.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML lang="en">
<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<title>IBM Toolbox for Java: Output queue attributes </title>
Expand Down
4 changes: 2 additions & 2 deletions src/main/javadoc/com/ibm/as400/access/doc-files/PrintAttributes.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<html>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>

<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
Expand Down
4 changes: 2 additions & 2 deletions src/main/javadoc/com/ibm/as400/access/doc-files/PrinterAttrs.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML lang="en">
<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<title>IBM Toolbox for Java: Printer attributes </title>
Expand Down
4 changes: 2 additions & 2 deletions src/main/javadoc/com/ibm/as400/access/doc-files/PrinterFileAttrs.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML lang="en">
<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<title>IBM Toolbox for Java: Printer file attributes </title>
Expand Down
8 changes: 4 additions & 4 deletions src/main/javadoc/com/ibm/as400/access/doc-files/RLReadFileExample.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML lang="en">
<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<TITLE>IBM Toolbox for Java Example: Using Record-level Access Classes</TITLE>
Expand Down Expand Up @@ -41,7 +41,7 @@ <H3>Example: Using record-level access classes to read records from a file</H3>

// Continue only if a system name was specified.

if (parameters.length >= 1)
if (parameters.length &gt;= 1)
{

try
Expand Down Expand Up @@ -156,7 +156,7 @@ <H3>Example: Using record-level access classes to read records from a file</H3>
// from the record it is converted from i5/OS format to
// Java format.

if (((BigDecimal)data.getField(&quot;BALDUE&quot;)).floatValue() > 0.0)
if (((BigDecimal)data.getField(&quot;BALDUE&quot;)).floatValue() &gt; 0.0)
{
System.out.print((String) data.getField(&quot;INIT&quot;) + &quot; &quot;);
System.out.print((String) data.getField(&quot;LSTNAM&quot;) + &quot; &quot;);
Expand Down
6 changes: 3 additions & 3 deletions src/main/javadoc/com/ibm/as400/access/doc-files/SQLTypes.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML lang="en">
<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<TITLE>IBM Toolbox for Java: JDBC SQL Types</TITLE>
Expand All @@ -19,7 +19,7 @@ <H2><A NAME="unsupported">Unsupported SQL Types</A></H2>
<P>The following table lists the SQL types that are not supported
and the SQL type that JDBC driver substitutes for each.</P>

<TABLE BORDER="1">
<TABLE BORDER="1" SUMMARY="Unsupported SQL Types">
<TR VALIGN="bottom" CLASS="hilightbar">
<TH ID="t1">Unsupported SQL type</TH>
<TH ID="t2">Substituted SQL type</TH>
Expand Down
4 changes: 2 additions & 2 deletions src/main/javadoc/com/ibm/as400/access/doc-files/SpooledFileAttrs.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<html>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>

<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
Expand Down
Loading

0 comments on commit 8c4ae13

Please sign in to comment.