Skip to content

Commit 9a65303

Browse files
cowwoccowwoc
committed
Publishing documentation for version 0.8
1 parent 49c0148 commit 9a65303

File tree

155 files changed

+24966
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

155 files changed

+24966
-0
lines changed

‎docs/api/0.8/allclasses-index.html‎

Lines changed: 240 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/api/0.8/allpackages-index.html‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
<!DOCTYPE HTML>
2+
<html lang>
3+
<head>
4+
<!-- Generated by javadoc (23) on Fri Feb 14 13:09:37 UTC 2025 -->
5+
<title>All Packages (Docker 0.8 API)</title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8+
<meta name="dc.created" content="2025-02-14">
9+
<meta name="description" content="package index">
10+
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
11+
<link rel="stylesheet" type="text/css" href="resource-files/jquery-ui.min.css" title="Style">
12+
<link rel="stylesheet" type="text/css" href="resource-files/stylesheet.css" title="Style">
13+
<script type="text/javascript" src="script-files/script.js"></script>
14+
<script type="text/javascript" src="script-files/jquery-3.7.1.min.js"></script>
15+
<script type="text/javascript" src="script-files/jquery-ui.min.js"></script>
16+
</head>
17+
<body class="all-packages-index-page">
18+
<script type="text/javascript">const pathtoroot = "./";
19+
loadScripts(document, 'script');</script>
20+
<noscript>
21+
<div>JavaScript is disabled on your browser.</div>
22+
</noscript>
23+
<header role="banner">
24+
<nav role="navigation">
25+
<!-- ========= START OF TOP NAVBAR ======= -->
26+
<div class="top-nav" id="navbar-top">
27+
<div class="nav-content">
28+
<div class="nav-menu-button"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button></div>
29+
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
30+
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
31+
<li><a href="com.github.cowwoc.docker/module-summary.html">Module</a></li>
32+
<li><a href="overview-tree.html">Tree</a></li>
33+
<li><a href="index-all.html">Index</a></li>
34+
<li><a href="search.html">Search</a></li>
35+
<li><a href="help-doc.html#all-packages">Help</a></li>
36+
</ul>
37+
</div>
38+
</div>
39+
<div class="sub-nav">
40+
<div class="nav-content">
41+
<ol class="sub-nav-list"></ol>
42+
<div class="nav-list-search">
43+
<input type="text" id="search-input" disabled placeholder="Search" aria-label="Search in documentation" autocomplete="off">
44+
<input type="reset" id="reset-search" disabled value="Reset">
45+
</div>
46+
</div>
47+
</div>
48+
<!-- ========= END OF TOP NAVBAR ========= -->
49+
<span class="skip-nav" id="skip-navbar-top"></span></nav>
50+
</header>
51+
<div class="main-grid">
52+
<main role="main">
53+
<div class="header">
54+
<h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
55+
</div>
56+
<div class="caption"><span>Package Summary</span></div>
57+
<div class="summary-table two-column-summary">
58+
<div class="table-header col-first">Package</div>
59+
<div class="table-header col-last">Description</div>
60+
<div class="col-first even-row-color"><a href="com.github.cowwoc.docker/com/github/cowwoc/docker/client/package-summary.html">com.github.cowwoc.docker.client</a></div>
61+
<div class="col-last even-row-color">&nbsp;</div>
62+
<div class="col-first odd-row-color"><a href="com.github.cowwoc.docker/com/github/cowwoc/docker/exception/package-summary.html">com.github.cowwoc.docker.exception</a></div>
63+
<div class="col-last odd-row-color">&nbsp;</div>
64+
<div class="col-first even-row-color"><a href="com.github.cowwoc.docker/com/github/cowwoc/docker/internal/util/package-summary.html">com.github.cowwoc.docker.internal.util</a></div>
65+
<div class="col-last even-row-color">&nbsp;</div>
66+
<div class="col-first odd-row-color"><a href="com.github.cowwoc.docker/com/github/cowwoc/docker/resource/package-summary.html">com.github.cowwoc.docker.resource</a></div>
67+
<div class="col-last odd-row-color">&nbsp;</div>
68+
</div>
69+
<footer role="contentinfo">
70+
<hr>
71+
<p class="legal-copy"><small>Copyright &#169; 2025. All rights reserved.</small></p>
72+
</footer>
73+
</main>
74+
</div>
75+
</body>
76+
</html>

‎docs/api/0.8/com.github.cowwoc.docker/com/github/cowwoc/docker/client/DockerClient.html‎

Lines changed: 214 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,214 @@
1+
<!DOCTYPE HTML>
2+
<html lang>
3+
<head>
4+
<!-- Generated by javadoc (23) on Fri Feb 14 13:09:37 UTC 2025 -->
5+
<title>DockerClient (Docker 0.8 API)</title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8+
<meta name="dc.created" content="2025-02-14">
9+
<meta name="description" content="declaration: module: com.github.cowwoc.docker, package: com.github.cowwoc.docker.client, interface: DockerClient">
10+
<meta name="generator" content="javadoc/ClassWriter">
11+
<link rel="stylesheet" type="text/css" href="../../../../../../resource-files/jquery-ui.min.css" title="Style">
12+
<link rel="stylesheet" type="text/css" href="../../../../../../resource-files/stylesheet.css" title="Style">
13+
<script type="text/javascript" src="../../../../../../script-files/script.js"></script>
14+
<script type="text/javascript" src="../../../../../../script-files/jquery-3.7.1.min.js"></script>
15+
<script type="text/javascript" src="../../../../../../script-files/jquery-ui.min.js"></script>
16+
</head>
17+
<body class="class-declaration-page">
18+
<script type="text/javascript">const pathtoroot = "../../../../../../";
19+
loadScripts(document, 'script');</script>
20+
<noscript>
21+
<div>JavaScript is disabled on your browser.</div>
22+
</noscript>
23+
<header role="banner">
24+
<nav role="navigation">
25+
<!-- ========= START OF TOP NAVBAR ======= -->
26+
<div class="top-nav" id="navbar-top">
27+
<div class="nav-content">
28+
<div class="nav-menu-button"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button></div>
29+
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
30+
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
31+
<li><a href="../../../../../module-summary.html">Module</a></li>
32+
<li class="nav-bar-cell1-rev">Class</li>
33+
<li><a href="class-use/DockerClient.html">Use</a></li>
34+
<li><a href="package-tree.html">Tree</a></li>
35+
<li><a href="../../../../../../index-all.html">Index</a></li>
36+
<li><a href="../../../../../../search.html">Search</a></li>
37+
<li><a href="../../../../../../help-doc.html#class">Help</a></li>
38+
</ul>
39+
</div>
40+
</div>
41+
<div class="sub-nav">
42+
<div class="nav-content">
43+
<ol class="sub-nav-list">
44+
<li><a href="../../../../../module-summary.html">com.github.cowwoc.docker</a></li>
45+
<li><a href="package-summary.html">com.github.cowwoc.docker.client</a></li>
46+
<li><a href="DockerClient.html" class="current-selection">DockerClient</a></li>
47+
</ol>
48+
<div class="nav-list-search">
49+
<input type="text" id="search-input" disabled placeholder="Search" aria-label="Search in documentation" autocomplete="off">
50+
<input type="reset" id="reset-search" disabled value="Reset">
51+
</div>
52+
</div>
53+
</div>
54+
<!-- ========= END OF TOP NAVBAR ========= -->
55+
<span class="skip-nav" id="skip-navbar-top"></span></nav>
56+
</header>
57+
<div class="main-grid">
58+
<nav role="navigation" class="toc" aria-label="Table of contents">
59+
<div class="toc-header">Contents&nbsp;
60+
<input type="text" class="filter-input" disabled placeholder="Filter" aria-label="Filter table of contents" autocomplete="off">
61+
<input type="reset" class="reset-filter" disabled value="Reset">
62+
</div>
63+
<button class="hide-sidebar"><span>Hide sidebar&nbsp;</span>&#10094;</button><button class="show-sidebar">&#10095;<span>&nbsp;Show sidebar</span></button>
64+
<ol class="toc-list">
65+
<li><a href="#" tabindex="0">Description</a></li>
66+
<li><a href="#method-summary" tabindex="0">Method Summary</a></li>
67+
<li><a href="#method-detail" tabindex="0">Method Details</a>
68+
<ol class="toc-list">
69+
<li><a href="#usingUnixSocket(java.nio.file.Path)" tabindex="0">usingUnixSocket(Path)</a></li>
70+
<li><a href="#usingTcpIp(java.net.URI)" tabindex="0">usingTcpIp(URI)</a></li>
71+
<li><a href="#isClosed()" tabindex="0">isClosed()</a></li>
72+
<li><a href="#close()" tabindex="0">close()</a></li>
73+
</ol>
74+
</li>
75+
</ol>
76+
</nav>
77+
<main role="main">
78+
<!-- ======== START OF CLASS DATA ======== -->
79+
<div class="header">
80+
<h1 title="Interface DockerClient" class="title">Interface DockerClient</h1>
81+
</div>
82+
<section class="class-description" id="class-description">
83+
<div class="horizontal-scroll">
84+
<dl class="notes">
85+
<dt>All Superinterfaces:</dt>
86+
<dd><code><a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd>
87+
</dl>
88+
<hr>
89+
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">DockerClient</span><span class="extends-implements">
90+
extends <a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></span></div>
91+
<div class="block">A client of the Docker REST API.</div>
92+
</div>
93+
</section>
94+
<section class="summary">
95+
<ul class="summary-list">
96+
<!-- ========== METHOD SUMMARY =========== -->
97+
<li>
98+
<section class="method-summary" id="method-summary">
99+
<h2>Method Summary</h2>
100+
<div id="method-summary-table">
101+
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
102+
<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0">
103+
<div class="summary-table three-column-summary">
104+
<div class="table-header col-first">Modifier and Type</div>
105+
<div class="table-header col-second">Method</div>
106+
<div class="table-header col-last">Description</div>
107+
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
108+
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#close()" class="member-name-link">close</a>()</code></div>
109+
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
110+
<div class="block">Closes the client.</div>
111+
</div>
112+
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
113+
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isClosed()" class="member-name-link">isClosed</a>()</code></div>
114+
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
115+
<div class="block">Determines if the client is closed.</div>
116+
</div>
117+
<div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static <a href="DockerClient.html" title="interface in com.github.cowwoc.docker.client">DockerClient</a></code></div>
118+
<div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#usingTcpIp(java.net.URI)" class="member-name-link">usingTcpIp</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a>&nbsp;uri)</code></div>
119+
<div class="col-last even-row-color method-summary-table method-summary-table-tab1">
120+
<div class="block">Creates a client that communicates with the server over TCP/IP.</div>
121+
</div>
122+
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static <a href="DockerClient.html" title="interface in com.github.cowwoc.docker.client">DockerClient</a></code></div>
123+
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#usingUnixSocket(java.nio.file.Path)" class="member-name-link">usingUnixSocket</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a>&nbsp;path)</code></div>
124+
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1">
125+
<div class="block">Creates a client that communicates with the server over a Unix socket.</div>
126+
</div>
127+
</div>
128+
</div>
129+
</div>
130+
</section>
131+
</li>
132+
</ul>
133+
</section>
134+
<section class="details">
135+
<ul class="details-list">
136+
<!-- ============ METHOD DETAIL ========== -->
137+
<li>
138+
<section class="method-details" id="method-detail">
139+
<h2>Method Details</h2>
140+
<ul class="member-list">
141+
<li>
142+
<section class="detail" id="usingUnixSocket(java.nio.file.Path)">
143+
<h3>usingUnixSocket</h3>
144+
<div class="horizontal-scroll">
145+
<div class="member-signature"><span class="modifiers">static</span>&nbsp;<span class="return-type"><a href="DockerClient.html" title="interface in com.github.cowwoc.docker.client">DockerClient</a></span>&nbsp;<span class="element-name">usingUnixSocket</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a>&nbsp;path)</span></div>
146+
<div class="block">Creates a client that communicates with the server over a Unix socket.</div>
147+
<dl class="notes">
148+
<dt>Parameters:</dt>
149+
<dd><code>path</code> - the unix socket of the REST server (e.g. <code>/var/run/docker.sock</code>)</dd>
150+
<dt>Returns:</dt>
151+
<dd>a new client</dd>
152+
<dt>Throws:</dt>
153+
<dd><code><a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if <code>path</code> is null</dd>
154+
</dl>
155+
</div>
156+
</section>
157+
</li>
158+
<li>
159+
<section class="detail" id="usingTcpIp(java.net.URI)">
160+
<h3>usingTcpIp</h3>
161+
<div class="horizontal-scroll">
162+
<div class="member-signature"><span class="modifiers">static</span>&nbsp;<span class="return-type"><a href="DockerClient.html" title="interface in com.github.cowwoc.docker.client">DockerClient</a></span>&nbsp;<span class="element-name">usingTcpIp</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a>&nbsp;uri)</span></div>
163+
<div class="block">Creates a client that communicates with the server over TCP/IP.</div>
164+
<dl class="notes">
165+
<dt>Parameters:</dt>
166+
<dd><code>uri</code> - the URI of the REST server (e.g. <code>http://localhost:2375/</code>)</dd>
167+
<dt>Returns:</dt>
168+
<dd>a new client</dd>
169+
<dt>Throws:</dt>
170+
<dd><code><a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if <code>uri</code> is null</dd>
171+
</dl>
172+
</div>
173+
</section>
174+
</li>
175+
<li>
176+
<section class="detail" id="isClosed()">
177+
<h3>isClosed</h3>
178+
<div class="horizontal-scroll">
179+
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isClosed</span>()</div>
180+
<div class="block">Determines if the client is closed.</div>
181+
<dl class="notes">
182+
<dt>Returns:</dt>
183+
<dd><code>true</code> if the client is closed</dd>
184+
</dl>
185+
</div>
186+
</section>
187+
</li>
188+
<li>
189+
<section class="detail" id="close()">
190+
<h3>close</h3>
191+
<div class="horizontal-scroll">
192+
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">close</span>()</div>
193+
<div class="block">Closes the client.</div>
194+
<dl class="notes">
195+
<dt>Specified by:</dt>
196+
<dd><code><a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd>
197+
</dl>
198+
</div>
199+
</section>
200+
</li>
201+
</ul>
202+
</section>
203+
</li>
204+
</ul>
205+
</section>
206+
<!-- ========= END OF CLASS DATA ========= -->
207+
<footer role="contentinfo">
208+
<hr>
209+
<p class="legal-copy"><small>Copyright &#169; 2025. All rights reserved.</small></p>
210+
</footer>
211+
</main>
212+
</div>
213+
</body>
214+
</html>

0 commit comments

Comments
 (0)