Skip to content

Commit

Permalink
Javadoc update
Browse files Browse the repository at this point in the history
  • Loading branch information
@michaelgantman
michaelgantman committed Jun 25, 2023
1 parent f614023 commit 493f870
Show file tree
Hide file tree
Showing 132 changed files with 2,179 additions and 7,489 deletions.
15 changes: 4 additions & 11 deletions docs/allclasses-frame.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_311) on Sun Feb 12 19:01:11 EET 2023 -->
<!-- Generated by javadoc (1.8.0_311) on Sun Jun 25 16:12:48 EEST 2023 -->
<title>All Classes</title>
<meta name="date" content="2023-02-12">
<meta name="date" content="2023-06-25">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand All @@ -14,33 +14,26 @@ <h1 class="bar">All&nbsp;Classes</h1>
<ul>
<li><a href="com/mgnt/lifecycle/management/backgroundrunner/BackgroundRunnable.html" title="interface in com.mgnt.lifecycle.management.backgroundrunner" target="classFrame"><span class="interfaceName">BackgroundRunnable</span></a></li>
<li><a href="com/mgnt/lifecycle/management/backgroundrunner/BackgroundRunnableFactory.html" title="class in com.mgnt.lifecycle.management.backgroundrunner" target="classFrame">BackgroundRunnableFactory</a></li>
<li><a href="com/mgnt/lifecycle/management/backgroundrunner/example/BackgroundRunnerUsageExample.html" title="class in com.mgnt.lifecycle.management.backgroundrunner.example" target="classFrame">BackgroundRunnerUsageExample</a></li>
<li><a href="com/mgnt/lifecycle/management/backgroundrunner/BackgroundThreadsRunner.html" title="class in com.mgnt.lifecycle.management.backgroundrunner" target="classFrame">BackgroundThreadsRunner</a></li>
<li><a href="com/mgnt/lifecycle/management/backgroundrunner/BaseBackgroundRunnable.html" title="class in com.mgnt.lifecycle.management.backgroundrunner" target="classFrame">BaseBackgroundRunnable</a></li>
<li><a href="com/mgnt/lifecycle/management/BaseEntity.html" title="class in com.mgnt.lifecycle.management" target="classFrame">BaseEntity</a></li>
<li><a href="com/mgnt/lifecycle/management/BaseEntityFactory.html" title="class in com.mgnt.lifecycle.management" target="classFrame">BaseEntityFactory</a></li>
<li><a href="com/mgnt/lifecycle/management/example/BaseInfoFormatter.html" title="class in com.mgnt.lifecycle.management.example" target="classFrame">BaseInfoFormatter</a></li>
<li><a href="com/mgnt/utils/FileUtils.html" title="class in com.mgnt.utils" target="classFrame">FileUtils</a></li>
<li><a href="com/mgnt/lifecycle/management/httpclient/HttpClient.html" title="class in com.mgnt.lifecycle.management.httpclient" target="classFrame">HttpClient</a></li>
<li><a href="com/mgnt/lifecycle/management/httpclient/HttpClient.HttpMethod.html" title="enum in com.mgnt.lifecycle.management.httpclient" target="classFrame">HttpClient.HttpMethod</a></li>
<li><a href="com/mgnt/lifecycle/management/example/InfoFormatter.html" title="interface in com.mgnt.lifecycle.management.example" target="classFrame"><span class="interfaceName">InfoFormatter</span></a></li>
<li><a href="com/mgnt/lifecycle/management/example/InfoFormatterFactory.html" title="class in com.mgnt.lifecycle.management.example" target="classFrame">InfoFormatterFactory</a></li>
<li><a href="com/mgnt/lifecycle/management/httpclient/HttpClientCommunicationException.html" title="class in com.mgnt.lifecycle.management.httpclient" target="classFrame">HttpClientCommunicationException</a></li>
<li><a href="com/mgnt/utils/textutils/InvalidVersionFormatException.html" title="class in com.mgnt.utils.textutils" target="classFrame">InvalidVersionFormatException</a></li>
<li><a href="com/mgnt/utils/textutils/InvalidVersionRangeException.html" title="class in com.mgnt.utils.textutils" target="classFrame">InvalidVersionRangeException</a></li>
<li><a href="com/mgnt/lifecycle/management/example/implementations/JsonInfoFormatter.html" title="class in com.mgnt.lifecycle.management.example.implementations" target="classFrame">JsonInfoFormatter</a></li>
<li><a href="com/mgnt/utils/JsonUtils.html" title="class in com.mgnt.utils" target="classFrame">JsonUtils</a></li>
<li><a href="com/mgnt/lifecycle/management/httpclient/ResponseHolder.html" title="class in com.mgnt.lifecycle.management.httpclient" target="classFrame">ResponseHolder</a></li>
<li><a href="com/mgnt/utils/StringUnicodeEncoderDecoder.html" title="class in com.mgnt.utils" target="classFrame">StringUnicodeEncoderDecoder</a></li>
<li><a href="com/mgnt/utils/TextUtils.html" title="class in com.mgnt.utils" target="classFrame">TextUtils</a></li>
<li><a href="com/mgnt/utils/entities/TimeInterval.html" title="class in com.mgnt.utils.entities" target="classFrame">TimeInterval</a></li>
<li><a href="com/mgnt/utils/TimeUtils.html" title="class in com.mgnt.utils" target="classFrame">TimeUtils</a></li>
<li><a href="com/mgnt/lifecycle/management/backgroundrunner/example/TypeOneTask.html" title="class in com.mgnt.lifecycle.management.backgroundrunner.example" target="classFrame">TypeOneTask</a></li>
<li><a href="com/mgnt/lifecycle/management/backgroundrunner/example/TypeTwoTask.html" title="class in com.mgnt.lifecycle.management.backgroundrunner.example" target="classFrame">TypeTwoTask</a></li>
<li><a href="com/mgnt/lifecycle/management/example/implementations/usage/UsageExample.html" title="class in com.mgnt.lifecycle.management.example.implementations.usage" target="classFrame">UsageExample</a></li>
<li><a href="com/mgnt/utils/textutils/Version.html" title="class in com.mgnt.utils.textutils" target="classFrame">Version</a></li>
<li><a href="com/mgnt/utils/textutils/VersionComparator.html" title="class in com.mgnt.utils.textutils" target="classFrame">VersionComparator</a></li>
<li><a href="com/mgnt/utils/textutils/VersionRange.html" title="class in com.mgnt.utils.textutils" target="classFrame">VersionRange</a></li>
<li><a href="com/mgnt/utils/WebUtils.html" title="class in com.mgnt.utils" target="classFrame">WebUtils</a></li>
<li><a href="com/mgnt/lifecycle/management/example/implementations/XmlInfoFormatter.html" title="class in com.mgnt.lifecycle.management.example.implementations" target="classFrame">XmlInfoFormatter</a></li>
</ul>
</div>
</body>
Expand Down
15 changes: 4 additions & 11 deletions docs/allclasses-noframe.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_311) on Sun Feb 12 19:01:11 EET 2023 -->
<!-- Generated by javadoc (1.8.0_311) on Sun Jun 25 16:12:48 EEST 2023 -->
<title>All Classes</title>
<meta name="date" content="2023-02-12">
<meta name="date" content="2023-06-25">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand All @@ -14,33 +14,26 @@ <h1 class="bar">All&nbsp;Classes</h1>
<ul>
<li><a href="com/mgnt/lifecycle/management/backgroundrunner/BackgroundRunnable.html" title="interface in com.mgnt.lifecycle.management.backgroundrunner"><span class="interfaceName">BackgroundRunnable</span></a></li>
<li><a href="com/mgnt/lifecycle/management/backgroundrunner/BackgroundRunnableFactory.html" title="class in com.mgnt.lifecycle.management.backgroundrunner">BackgroundRunnableFactory</a></li>
<li><a href="com/mgnt/lifecycle/management/backgroundrunner/example/BackgroundRunnerUsageExample.html" title="class in com.mgnt.lifecycle.management.backgroundrunner.example">BackgroundRunnerUsageExample</a></li>
<li><a href="com/mgnt/lifecycle/management/backgroundrunner/BackgroundThreadsRunner.html" title="class in com.mgnt.lifecycle.management.backgroundrunner">BackgroundThreadsRunner</a></li>
<li><a href="com/mgnt/lifecycle/management/backgroundrunner/BaseBackgroundRunnable.html" title="class in com.mgnt.lifecycle.management.backgroundrunner">BaseBackgroundRunnable</a></li>
<li><a href="com/mgnt/lifecycle/management/BaseEntity.html" title="class in com.mgnt.lifecycle.management">BaseEntity</a></li>
<li><a href="com/mgnt/lifecycle/management/BaseEntityFactory.html" title="class in com.mgnt.lifecycle.management">BaseEntityFactory</a></li>
<li><a href="com/mgnt/lifecycle/management/example/BaseInfoFormatter.html" title="class in com.mgnt.lifecycle.management.example">BaseInfoFormatter</a></li>
<li><a href="com/mgnt/utils/FileUtils.html" title="class in com.mgnt.utils">FileUtils</a></li>
<li><a href="com/mgnt/lifecycle/management/httpclient/HttpClient.html" title="class in com.mgnt.lifecycle.management.httpclient">HttpClient</a></li>
<li><a href="com/mgnt/lifecycle/management/httpclient/HttpClient.HttpMethod.html" title="enum in com.mgnt.lifecycle.management.httpclient">HttpClient.HttpMethod</a></li>
<li><a href="com/mgnt/lifecycle/management/example/InfoFormatter.html" title="interface in com.mgnt.lifecycle.management.example"><span class="interfaceName">InfoFormatter</span></a></li>
<li><a href="com/mgnt/lifecycle/management/example/InfoFormatterFactory.html" title="class in com.mgnt.lifecycle.management.example">InfoFormatterFactory</a></li>
<li><a href="com/mgnt/lifecycle/management/httpclient/HttpClientCommunicationException.html" title="class in com.mgnt.lifecycle.management.httpclient">HttpClientCommunicationException</a></li>
<li><a href="com/mgnt/utils/textutils/InvalidVersionFormatException.html" title="class in com.mgnt.utils.textutils">InvalidVersionFormatException</a></li>
<li><a href="com/mgnt/utils/textutils/InvalidVersionRangeException.html" title="class in com.mgnt.utils.textutils">InvalidVersionRangeException</a></li>
<li><a href="com/mgnt/lifecycle/management/example/implementations/JsonInfoFormatter.html" title="class in com.mgnt.lifecycle.management.example.implementations">JsonInfoFormatter</a></li>
<li><a href="com/mgnt/utils/JsonUtils.html" title="class in com.mgnt.utils">JsonUtils</a></li>
<li><a href="com/mgnt/lifecycle/management/httpclient/ResponseHolder.html" title="class in com.mgnt.lifecycle.management.httpclient">ResponseHolder</a></li>
<li><a href="com/mgnt/utils/StringUnicodeEncoderDecoder.html" title="class in com.mgnt.utils">StringUnicodeEncoderDecoder</a></li>
<li><a href="com/mgnt/utils/TextUtils.html" title="class in com.mgnt.utils">TextUtils</a></li>
<li><a href="com/mgnt/utils/entities/TimeInterval.html" title="class in com.mgnt.utils.entities">TimeInterval</a></li>
<li><a href="com/mgnt/utils/TimeUtils.html" title="class in com.mgnt.utils">TimeUtils</a></li>
<li><a href="com/mgnt/lifecycle/management/backgroundrunner/example/TypeOneTask.html" title="class in com.mgnt.lifecycle.management.backgroundrunner.example">TypeOneTask</a></li>
<li><a href="com/mgnt/lifecycle/management/backgroundrunner/example/TypeTwoTask.html" title="class in com.mgnt.lifecycle.management.backgroundrunner.example">TypeTwoTask</a></li>
<li><a href="com/mgnt/lifecycle/management/example/implementations/usage/UsageExample.html" title="class in com.mgnt.lifecycle.management.example.implementations.usage">UsageExample</a></li>
<li><a href="com/mgnt/utils/textutils/Version.html" title="class in com.mgnt.utils.textutils">Version</a></li>
<li><a href="com/mgnt/utils/textutils/VersionComparator.html" title="class in com.mgnt.utils.textutils">VersionComparator</a></li>
<li><a href="com/mgnt/utils/textutils/VersionRange.html" title="class in com.mgnt.utils.textutils">VersionRange</a></li>
<li><a href="com/mgnt/utils/WebUtils.html" title="class in com.mgnt.utils">WebUtils</a></li>
<li><a href="com/mgnt/lifecycle/management/example/implementations/XmlInfoFormatter.html" title="class in com.mgnt.lifecycle.management.example.implementations">XmlInfoFormatter</a></li>
</ul>
</div>
</body>
Expand Down
6 changes: 3 additions & 3 deletions docs/com/mgnt/lifecycle/management/BaseEntity.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_311) on Sun Feb 12 19:01:11 EET 2023 -->
<!-- Generated by javadoc (1.8.0_311) on Sun Jun 25 16:12:47 EEST 2023 -->
<title>BaseEntity</title>
<meta name="date" content="2023-02-12">
<meta name="date" content="2023-06-25">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
Expand Down Expand Up @@ -107,7 +107,7 @@ <h2 title="Class BaseEntity" class="title">Class BaseEntity&lt;I&gt;</h2>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../com/mgnt/lifecycle/management/backgroundrunner/BaseBackgroundRunnable.html" title="class in com.mgnt.lifecycle.management.backgroundrunner">BaseBackgroundRunnable</a>, <a href="../../../../com/mgnt/lifecycle/management/example/BaseInfoFormatter.html" title="class in com.mgnt.lifecycle.management.example">BaseInfoFormatter</a></dd>
<dd><a href="../../../../com/mgnt/lifecycle/management/backgroundrunner/BaseBackgroundRunnable.html" title="class in com.mgnt.lifecycle.management.backgroundrunner">BaseBackgroundRunnable</a></dd>
</dl>
<hr>
<br>
Expand Down
6 changes: 3 additions & 3 deletions docs/com/mgnt/lifecycle/management/BaseEntityFactory.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_311) on Sun Feb 12 19:01:11 EET 2023 -->
<!-- Generated by javadoc (1.8.0_311) on Sun Jun 25 16:12:47 EEST 2023 -->
<title>BaseEntityFactory</title>
<meta name="date" content="2023-02-12">
<meta name="date" content="2023-06-25">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
Expand Down Expand Up @@ -113,7 +113,7 @@ <h2 title="Class BaseEntityFactory" class="title">Class BaseEntityFactory&lt;I&g
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../com/mgnt/lifecycle/management/backgroundrunner/BackgroundRunnableFactory.html" title="class in com.mgnt.lifecycle.management.backgroundrunner">BackgroundRunnableFactory</a>, <a href="../../../../com/mgnt/lifecycle/management/example/InfoFormatterFactory.html" title="class in com.mgnt.lifecycle.management.example">InfoFormatterFactory</a></dd>
<dd><a href="../../../../com/mgnt/lifecycle/management/backgroundrunner/BackgroundRunnableFactory.html" title="class in com.mgnt.lifecycle.management.backgroundrunner">BackgroundRunnableFactory</a></dd>
</dl>
<hr>
<br>
Expand Down
10 changes: 5 additions & 5 deletions docs/com/mgnt/lifecycle/management/backgroundrunner/BackgroundRunnable.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_311) on Sun Feb 12 19:01:11 EET 2023 -->
<!-- Generated by javadoc (1.8.0_311) on Sun Jun 25 16:12:47 EEST 2023 -->
<title>BackgroundRunnable</title>
<meta name="date" content="2023-02-12">
<meta name="date" content="2023-06-25">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
Expand Down Expand Up @@ -105,7 +105,7 @@ <h2 title="Interface BackgroundRunnable" class="title">Interface BackgroundRunna
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../com/mgnt/lifecycle/management/backgroundrunner/BaseBackgroundRunnable.html" title="class in com.mgnt.lifecycle.management.backgroundrunner">BaseBackgroundRunnable</a>, <a href="../../../../../com/mgnt/lifecycle/management/backgroundrunner/example/TypeOneTask.html" title="class in com.mgnt.lifecycle.management.backgroundrunner.example">TypeOneTask</a>, <a href="../../../../../com/mgnt/lifecycle/management/backgroundrunner/example/TypeTwoTask.html" title="class in com.mgnt.lifecycle.management.backgroundrunner.example">TypeTwoTask</a></dd>
<dd><a href="../../../../../com/mgnt/lifecycle/management/backgroundrunner/BaseBackgroundRunnable.html" title="class in com.mgnt.lifecycle.management.backgroundrunner">BaseBackgroundRunnable</a></dd>
</dl>
<hr>
<br>
Expand Down Expand Up @@ -234,8 +234,8 @@ <h4>setParamValue</h4>
java.lang.String&nbsp;property)</pre>
<div class="block">This method is a general setter method for all properties that hold <a href="../../../../../com/mgnt/utils/entities/TimeInterval.html" title="class in com.mgnt.utils.entities"><code>TimeInterval</code></a> value. It should be
implemented by user defined class implementing this interface. See source code for classes
<b><a href="../../../../../com/mgnt/lifecycle/management/backgroundrunner/example/TypeOneTask.html" title="class in com.mgnt.lifecycle.management.backgroundrunner.example"><code>TypeOneTask</code></a></b> and
<b><a href="../../../../../com/mgnt/lifecycle/management/backgroundrunner/example/TypeTwoTask.html" title="class in com.mgnt.lifecycle.management.backgroundrunner.example"><code>TypeTwoTask</code></a></b> where one provide complex example
<b><code>TypeOneTask</code></b> and
<b><code>TypeTwoTask</code></b> where one provide complex example
in which there are other properties besides Task Execution Interval and second that demonstrates a minimalistic
implementation</div>
<dl>
Expand Down
4 changes: 2 additions & 2 deletions docs/com/mgnt/lifecycle/management/backgroundrunner/BackgroundRunnableFactory.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_311) on Sun Feb 12 19:01:11 EET 2023 -->
<!-- Generated by javadoc (1.8.0_311) on Sun Jun 25 16:12:47 EEST 2023 -->
<title>BackgroundRunnableFactory</title>
<meta name="date" content="2023-02-12">
<meta name="date" content="2023-06-25">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
Expand Down
4 changes: 2 additions & 2 deletions docs/com/mgnt/lifecycle/management/backgroundrunner/BackgroundThreadsRunner.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_311) on Sun Feb 12 19:01:11 EET 2023 -->
<!-- Generated by javadoc (1.8.0_311) on Sun Jun 25 16:12:47 EEST 2023 -->
<title>BackgroundThreadsRunner</title>
<meta name="date" content="2023-02-12">
<meta name="date" content="2023-06-25">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
Expand Down
8 changes: 2 additions & 6 deletions docs/com/mgnt/lifecycle/management/backgroundrunner/BaseBackgroundRunnable.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_311) on Sun Feb 12 19:01:11 EET 2023 -->
<!-- Generated by javadoc (1.8.0_311) on Sun Jun 25 16:12:47 EEST 2023 -->
<title>BaseBackgroundRunnable</title>
<meta name="date" content="2023-02-12">
<meta name="date" content="2023-06-25">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
Expand Down Expand Up @@ -116,10 +116,6 @@ <h2 title="Class BaseBackgroundRunnable" class="title">Class BaseBackgroundRunna
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../com/mgnt/lifecycle/management/backgroundrunner/BackgroundRunnable.html" title="interface in com.mgnt.lifecycle.management.backgroundrunner">BackgroundRunnable</a>, java.lang.Runnable</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../com/mgnt/lifecycle/management/backgroundrunner/example/TypeOneTask.html" title="class in com.mgnt.lifecycle.management.backgroundrunner.example">TypeOneTask</a>, <a href="../../../../../com/mgnt/lifecycle/management/backgroundrunner/example/TypeTwoTask.html" title="class in com.mgnt.lifecycle.management.backgroundrunner.example">TypeTwoTask</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">BaseBackgroundRunnable</span>
Expand Down
Loading

0 comments on commit 493f870

Please sign in to comment.