Skip to content

Commit 60a3518

Browse files
author
Marcus Linke
committed
Sync sources with eclipse code formatter and checkstyle
1 parent d5d77ad commit 60a3518

File tree

96 files changed

+1192
-653
lines changed

Some content is hidden

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

96 files changed

+1192
-653
lines changed

‎etc/docker-java-formatter.xml‎

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

‎src/main/java/com/github/dockerjava/api/DockerClient.java‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -107,12 +107,11 @@ public interface DockerClient extends Closeable {
107107
public CreateContainerCmd createContainerCmd(@Nonnull String image);
108108

109109
/**
110-
* Creates a new {@link StartContainerCmd} for the container with the given ID. The command can then be further
111-
* customized by using builder methods on it like {@link StartContainerCmd#withDns(String...)}.
110+
* Creates a new {@link StartContainerCmd} for the container with the given ID. The command can then be further customized by using
111+
* builder methods on it like {@link StartContainerCmd#withDns(String...)}.
112112
* <p>
113-
* <b>If you customize the command, any existing configuration of the target container will get reset to its default
114-
* before applying the new configuration. To preserve the existing configuration, use an unconfigured
115-
* {@link StartContainerCmd}.</b>
113+
* <b>If you customize the command, any existing configuration of the target container will get reset to its default before applying the
114+
* new configuration. To preserve the existing configuration, use an unconfigured {@link StartContainerCmd}.</b>
116115
* <p>
117116
* This command corresponds to the <code>/containers/{id}/start</code> endpoint of the Docker Remote API.
118117
*/

‎src/main/java/com/github/dockerjava/api/async/ResultCallback.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
*/
88
public interface ResultCallback<A_RES_T> extends Closeable {
99
/**
10-
* Called when the async processing starts respectively when the response arrives from the server. The passed
11-
* {@link Closeable} can be used to close/interrupt the processing.
10+
* Called when the async processing starts respectively when the response arrives from the server. The passed {@link Closeable} can be
11+
* used to close/interrupt the processing.
1212
*/
1313
void onStart(Closeable closeable);
1414

‎src/main/java/com/github/dockerjava/api/command/AttachContainerCmd.java‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,7 @@ public interface AttachContainerCmd extends AsyncDockerCmd<AttachContainerCmd, F
5050

5151
/**
5252
* Following the stream means the resulting {@link InputStream} returned by {@link #exec()} reads infinitely. So a
53-
* {@link InputStream#read()} MAY BLOCK FOREVER as long as no data is streamed from the docker host to
54-
* {@link DockerClient}!
53+
* {@link InputStream#read()} MAY BLOCK FOREVER as long as no data is streamed from the docker host to {@link DockerClient}!
5554
*/
5655
AttachContainerCmd withFollowStream(Boolean followStream);
5756

‎src/main/java/com/github/dockerjava/api/command/AuthCmd.java‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,8 @@ public interface AuthCmd extends SyncDockerCmd<AuthResponse> {
2020
public AuthCmd withAuthConfig(@Nonnull AuthConfig authConfig);
2121

2222
/**
23-
* @return The status. Based on it's value you may mean you need to authorise your account, e.g.:
24-
* "Account created. Please see the documentation of the registry http://localhost:5000/v1/
25-
* for instructions how to activate it."
23+
* @return The status. Based on it's value you may mean you need to authorise your account, e.g.: "Account created. Please see the
24+
* documentation of the registry http://localhost:5000/v1/ for instructions how to activate it."
2625
* @throws UnauthorizedException
2726
* If you're not authorised (e.g. bad password).
2827
*/

‎src/main/java/com/github/dockerjava/api/command/CopyArchiveToContainerCmd.java‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,28 +33,26 @@ public interface CopyArchiveToContainerCmd extends SyncDockerCmd<Void> {
3333
CopyArchiveToContainerCmd withHostResource(String resource);
3434

3535
/**
36-
* Set the tar input stream that will be uploaded to the container. withHostResource or withTarInputStream can be
37-
* defined but not both.
36+
* Set the tar input stream that will be uploaded to the container. withHostResource or withTarInputStream can be defined but not both.
3837
*
3938
* @param tarInputStream
4039
* the stream to upload to the container
4140
*/
4241
CopyArchiveToContainerCmd withTarInputStream(InputStream tarInputStream);
4342

4443
/**
45-
* If set to true then it will be an error if unpacking the given content would cause an existing directory to be
46-
* replaced with a non-directory and vice versa
44+
* If set to true then it will be an error if unpacking the given content would cause an existing directory to be replaced with a
45+
* non-directory and vice versa
4746
*
4847
* @param noOverwriteDirNonDir
4948
* flag to know if non directory can be overwritten
5049
*/
5150
CopyArchiveToContainerCmd withNoOverwriteDirNonDir(boolean noOverwriteDirNonDir);
5251

5352
/**
54-
* If this flag is set to true, all children of the local directory will be copied to the remote without the root
55-
* directory. For ex: if I have root/titi and root/tata and the remote path is /var/data. dirChildrenOnly = true
56-
* will create /var/data/titi and /var/data/tata dirChildrenOnly = false will create /var/data/root/titi and
57-
* /var/data/root/tata
53+
* If this flag is set to true, all children of the local directory will be copied to the remote without the root directory. For ex: if
54+
* I have root/titi and root/tata and the remote path is /var/data. dirChildrenOnly = true will create /var/data/titi and /var/data/tata
55+
* dirChildrenOnly = false will create /var/data/root/titi and /var/data/root/tata
5856
*
5957
* @param dirChildrenOnly
6058
* if root directory is ignored

‎src/main/java/com/github/dockerjava/api/command/CreateContainerCmd.java‎

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -195,30 +195,26 @@ public interface CreateContainerCmd extends SyncDockerCmd<CreateContainerRespons
195195
public CreateContainerCmd withBlkioWeight(Integer blkioWeight);
196196

197197
/**
198-
* Add linux <a href="http://man7.org/linux/man-pages/man7/capabilities.7.html">kernel capability</a> to the
199-
* container. For example: adding {@link Capability#MKNOD} allows the container to create special files using the
200-
* 'mknod' command.
198+
* Add linux <a href="http://man7.org/linux/man-pages/man7/capabilities.7.html">kernel capability</a> to the container. For example:
199+
* adding {@link Capability#MKNOD} allows the container to create special files using the 'mknod' command.
201200
*/
202201
public CreateContainerCmd withCapAdd(Capability... capAdd);
203202

204203
/**
205-
* Add linux <a href="http://man7.org/linux/man-pages/man7/capabilities.7.html">kernel capability</a> to the
206-
* container. For example: adding {@link Capability#MKNOD} allows the container to create special files using the
207-
* 'mknod' command.
204+
* Add linux <a href="http://man7.org/linux/man-pages/man7/capabilities.7.html">kernel capability</a> to the container. For example:
205+
* adding {@link Capability#MKNOD} allows the container to create special files using the 'mknod' command.
208206
*/
209207
public CreateContainerCmd withCapAdd(List<Capability> capAdd);
210208

211209
/**
212-
* Drop linux <a href="http://man7.org/linux/man-pages/man7/capabilities.7.html">kernel capability</a> from the
213-
* container. For example: dropping {@link Capability#CHOWN} prevents the container from changing the owner of any
214-
* files.
210+
* Drop linux <a href="http://man7.org/linux/man-pages/man7/capabilities.7.html">kernel capability</a> from the container. For example:
211+
* dropping {@link Capability#CHOWN} prevents the container from changing the owner of any files.
215212
*/
216213
public CreateContainerCmd withCapDrop(Capability... capDrop);
217214

218215
/**
219-
* Drop linux <a href="http://man7.org/linux/man-pages/man7/capabilities.7.html">kernel capability</a> from the
220-
* container. For example: dropping {@link Capability#CHOWN} prevents the container from changing the owner of any
221-
* files.
216+
* Drop linux <a href="http://man7.org/linux/man-pages/man7/capabilities.7.html">kernel capability</a> from the container. For example:
217+
* dropping {@link Capability#CHOWN} prevents the container from changing the owner of any files.
222218
*/
223219
public CreateContainerCmd withCapDrop(List<Capability> capDrop);
224220

@@ -334,8 +330,8 @@ public interface CreateContainerCmd extends SyncDockerCmd<CreateContainerRespons
334330
* <li>'bridge': creates a new network stack for the container on the docker bridge</li>
335331
* <li>'none': no networking for this container</li>
336332
* <li>'container:<name|id>': reuses another container network stack</li>
337-
* <li>'host': use the host network stack inside the container. Note: the host mode gives the container full access
338-
* to local system services such as D-bus and is therefore considered insecure.</li>
333+
* <li>'host': use the host network stack inside the container. Note: the host mode gives the container full access to local system
334+
* services such as D-bus and is therefore considered insecure.</li>
339335
* </ul>
340336
*/
341337
public CreateContainerCmd withNetworkMode(String networkMode);
@@ -346,14 +342,14 @@ public interface CreateContainerCmd extends SyncDockerCmd<CreateContainerRespons
346342
public CreateContainerCmd withOomKillDisable(Boolean oomKillDisable);
347343

348344
/**
349-
* Add one or more {@link PortBinding}s. This corresponds to the <code>--publish</code> (<code>-p</code>) option of
350-
* the <code>docker run</code> CLI command.
345+
* Add one or more {@link PortBinding}s. This corresponds to the <code>--publish</code> (<code>-p</code>) option of the
346+
* <code>docker run</code> CLI command.
351347
*/
352348
public CreateContainerCmd withPortBindings(PortBinding... portBindings);
353349

354350
/**
355-
* Add one or more {@link PortBinding}s. This corresponds to the <code>--publish</code> (<code>-p</code>) option of
356-
* the <code>docker run</code> CLI command.
351+
* Add one or more {@link PortBinding}s. This corresponds to the <code>--publish</code> (<code>-p</code>) option of the
352+
* <code>docker run</code> CLI command.
357353
*/
358354
public CreateContainerCmd withPortBindings(List<PortBinding> portBindings);
359355

‎src/main/java/com/github/dockerjava/api/command/CreateNetworkCmd.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public interface CreateNetworkCmd extends SyncDockerCmd<CreateNetworkResponse> {
3434
/** Name of the network driver to use. Defaults to <code>bridge</code>. */
3535
public CreateNetworkCmd withDriver(String driver);
3636

37-
/** Driver specific options */
37+
/** Driver specific options */
3838
public CreateNetworkCmd withOptions(Map<String, String> options);
3939

4040
public static interface Exec extends DockerCmdSyncExec<CreateNetworkCmd, CreateNetworkResponse> {

‎src/main/java/com/github/dockerjava/api/command/CreateVolumeCmd.java‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,10 @@ public interface CreateVolumeCmd extends SyncDockerCmd<CreateVolumeResponse> {
2929

3030
/**
3131
* @param driverOpts
32-
* - A mapping of driver options and values. These options are passed directly to the driver and are
33-
* driver specific.
32+
* - A mapping of driver options and values. These options are passed directly to the driver and are driver specific.
3433
*/
3534
public CreateVolumeCmd withDriverOpts(Map<String, String> driverOpts);
3635

3736
public static interface Exec extends DockerCmdSyncExec<CreateVolumeCmd, CreateVolumeResponse> {
3837
}
3938
}
40-

‎src/main/java/com/github/dockerjava/api/command/InspectContainerResponse.java‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -202,8 +202,6 @@ public String toString() {
202202
return ToStringBuilder.reflectionToString(this);
203203
}
204204

205-
206-
207205
@JsonIgnoreProperties(ignoreUnknown = true)
208206
public class ContainerState {
209207

0 commit comments

Comments
 (0)