read-write or read-only.
*/
public enum AccessMode {
- /** read-write */
+ /**
+ * read-write
+ */
rw,
- /** read-only */
+ /**
+ * read-only
+ */
ro;
/**
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/model/AuthConfig.java b/docker-java-api/src/main/java/com/github/dockerjava/api/model/AuthConfig.java
index cbb108571..9e6de27b1 100644
--- a/docker-java-api/src/main/java/com/github/dockerjava/api/model/AuthConfig.java
+++ b/docker-java-api/src/main/java/com/github/dockerjava/api/model/AuthConfig.java
@@ -107,6 +107,7 @@ public AuthConfig withAuth(String auth) {
public String getIdentitytoken() {
return identitytoken;
}
+
/**
* @see #identitytoken
*/
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/model/Bind.java b/docker-java-api/src/main/java/com/github/dockerjava/api/model/Bind.java
index a7c8dba26..b6a6453e5 100644
--- a/docker-java-api/src/main/java/com/github/dockerjava/api/model/Bind.java
+++ b/docker-java-api/src/main/java/com/github/dockerjava/api/model/Bind.java
@@ -91,47 +91,45 @@ public PropagationMode getPropagationMode() {
/**
* Parses a bind mount specification to a {@link Bind}.
*
- * @param serialized
- * the specification, e.g. /host:/container:ro
+ * @param serialized the specification, e.g. /host:/container:ro
* @return a {@link Bind} matching the specification
- * @throws IllegalArgumentException
- * if the specification cannot be parsed
+ * @throws IllegalArgumentException if the specification cannot be parsed
*/
public static Bind parse(String serialized) {
try {
// Split by ':' but not ':\' (Windows-style path)
String[] parts = serialized.split(":(?!\\\\)");
switch (parts.length) {
- case 2: {
- return new Bind(parts[0], new Volume(parts[1]));
- }
- case 3: {
- String[] flags = parts[2].split(",");
- AccessMode accessMode = AccessMode.DEFAULT;
- SELContext seMode = SELContext.DEFAULT;
- Boolean nocopy = null;
- PropagationMode propagationMode = PropagationMode.DEFAULT_MODE;
- for (String p : flags) {
- if (p.length() == 2) {
- accessMode = AccessMode.valueOf(p.toLowerCase());
- } else if ("nocopy".equals(p)) {
- nocopy = true;
- } else if (PropagationMode.SHARED.toString().equals(p)) {
- propagationMode = PropagationMode.SHARED;
- } else if (PropagationMode.SLAVE.toString().equals(p)) {
- propagationMode = PropagationMode.SLAVE;
- } else if (PropagationMode.PRIVATE.toString().equals(p)) {
- propagationMode = PropagationMode.PRIVATE;
- } else {
- seMode = SELContext.fromString(p);
- }
+ case 2: {
+ return new Bind(parts[0], new Volume(parts[1]));
}
+ case 3: {
+ String[] flags = parts[2].split(",");
+ AccessMode accessMode = AccessMode.DEFAULT;
+ SELContext seMode = SELContext.DEFAULT;
+ Boolean nocopy = null;
+ PropagationMode propagationMode = PropagationMode.DEFAULT_MODE;
+ for (String p : flags) {
+ if (p.length() == 2) {
+ accessMode = AccessMode.valueOf(p.toLowerCase());
+ } else if ("nocopy".equals(p)) {
+ nocopy = true;
+ } else if (PropagationMode.SHARED.toString().equals(p)) {
+ propagationMode = PropagationMode.SHARED;
+ } else if (PropagationMode.SLAVE.toString().equals(p)) {
+ propagationMode = PropagationMode.SLAVE;
+ } else if (PropagationMode.PRIVATE.toString().equals(p)) {
+ propagationMode = PropagationMode.PRIVATE;
+ } else {
+ seMode = SELContext.fromString(p);
+ }
+ }
- return new Bind(parts[0], new Volume(parts[1]), accessMode, seMode, nocopy, propagationMode);
- }
- default: {
- throw new IllegalArgumentException();
- }
+ return new Bind(parts[0], new Volume(parts[1]), accessMode, seMode, nocopy, propagationMode);
+ }
+ default: {
+ throw new IllegalArgumentException();
+ }
}
} catch (Exception e) {
throw new IllegalArgumentException("Error parsing Bind '" + serialized + "'", e);
@@ -148,11 +146,11 @@ public static Bind parse(String serialized) {
@Override
public String toString() {
return String.format("%s:%s:%s%s%s%s",
- path,
- volume.getPath(),
- accessMode.toString(),
- secMode != SELContext.none ? "," + secMode.toString() : "",
- noCopy != null ? ",nocopy" : "",
- propagationMode != PropagationMode.DEFAULT_MODE ? "," + propagationMode.toString() : "");
+ path,
+ volume.getPath(),
+ accessMode.toString(),
+ secMode != SELContext.none ? "," + secMode.toString() : "",
+ noCopy != null ? ",nocopy" : "",
+ propagationMode != PropagationMode.DEFAULT_MODE ? "," + propagationMode.toString() : "");
}
}
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/model/Binds.java b/docker-java-api/src/main/java/com/github/dockerjava/api/model/Binds.java
index 06aff4ecf..b866f5dff 100644
--- a/docker-java-api/src/main/java/com/github/dockerjava/api/model/Binds.java
+++ b/docker-java-api/src/main/java/com/github/dockerjava/api/model/Binds.java
@@ -1,11 +1,11 @@
package com.github.dockerjava.api.model;
-import java.io.Serializable;
-import java.util.stream.Stream;
-
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
+import java.io.Serializable;
+import java.util.stream.Stream;
+
public class Binds implements Serializable {
private static final long serialVersionUID = 1L;
@@ -27,7 +27,7 @@ public String[] toPrimitive() {
@JsonCreator
public static Binds fromPrimitive(String[] binds) {
return new Binds(
- Stream.of(binds).map(Bind::parse).toArray(Bind[]::new)
+ Stream.of(binds).map(Bind::parse).toArray(Bind[]::new)
);
}
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/model/ChangeLog.java b/docker-java-api/src/main/java/com/github/dockerjava/api/model/ChangeLog.java
index c8a5be890..9dd107184 100644
--- a/docker-java-api/src/main/java/com/github/dockerjava/api/model/ChangeLog.java
+++ b/docker-java-api/src/main/java/com/github/dockerjava/api/model/ChangeLog.java
@@ -7,9 +7,7 @@
import java.io.Serializable;
/**
- *
* @author Konstantin Pelykh (kpelykh@gmail.com)
- *
*/
@EqualsAndHashCode
@ToString
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/model/ClusterInfo.java b/docker-java-api/src/main/java/com/github/dockerjava/api/model/ClusterInfo.java
index b6e1e5566..5cd5298ab 100644
--- a/docker-java-api/src/main/java/com/github/dockerjava/api/model/ClusterInfo.java
+++ b/docker-java-api/src/main/java/com/github/dockerjava/api/model/ClusterInfo.java
@@ -81,6 +81,7 @@ public ClusterInfo withSpec(SwarmSpec spec) {
this.spec = spec;
return this;
}
+
/**
* @see #id
*/
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/model/Device.java b/docker-java-api/src/main/java/com/github/dockerjava/api/model/Device.java
index b6f16029e..dfbf58e46 100644
--- a/docker-java-api/src/main/java/com/github/dockerjava/api/model/Device.java
+++ b/docker-java-api/src/main/java/com/github/dockerjava/api/model/Device.java
@@ -1,7 +1,5 @@
package com.github.dockerjava.api.model;
-import static java.util.Objects.requireNonNull;
-
import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.EqualsAndHashCode;
import lombok.ToString;
@@ -12,6 +10,8 @@
import java.util.Map;
import java.util.StringTokenizer;
+import static java.util.Objects.requireNonNull;
+
@EqualsAndHashCode
@ToString
public class Device extends DockerObject implements Serializable {
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/model/Event.java b/docker-java-api/src/main/java/com/github/dockerjava/api/model/Event.java
index 0eedbc553..c5d922cbd 100644
--- a/docker-java-api/src/main/java/com/github/dockerjava/api/model/Event.java
+++ b/docker-java-api/src/main/java/com/github/dockerjava/api/model/Event.java
@@ -5,7 +5,6 @@
import lombok.ToString;
import javax.annotation.CheckForNull;
-
import java.io.Serializable;
/**
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/model/ExposedPort.java b/docker-java-api/src/main/java/com/github/dockerjava/api/model/ExposedPort.java
index 4226fd94b..60a934afd 100644
--- a/docker-java-api/src/main/java/com/github/dockerjava/api/model/ExposedPort.java
+++ b/docker-java-api/src/main/java/com/github/dockerjava/api/model/ExposedPort.java
@@ -1,16 +1,16 @@
package com.github.dockerjava.api.model;
-import static com.github.dockerjava.api.model.InternetProtocol.TCP;
-import static com.github.dockerjava.api.model.InternetProtocol.UDP;
-import static com.github.dockerjava.api.model.InternetProtocol.SCTP;
-
-import java.io.Serializable;
-
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
import com.github.dockerjava.api.model.Ports.Binding;
import lombok.EqualsAndHashCode;
+import java.io.Serializable;
+
+import static com.github.dockerjava.api.model.InternetProtocol.SCTP;
+import static com.github.dockerjava.api.model.InternetProtocol.TCP;
+import static com.github.dockerjava.api.model.InternetProtocol.UDP;
+
/**
* Represents a container port that Docker exposes to external clients. The port is defined by its {@link #getPort() port number} and an
* {@link InternetProtocol}. It can be published by Docker by {@link Ports#bind(ExposedPort, Binding) binding} it to a host port,
@@ -27,10 +27,8 @@ public class ExposedPort implements Serializable {
/**
* Creates an {@link ExposedPort} for the given parameters.
*
- * @param port
- * the {@link #getPort() port number}
- * @param protocol
- * the {@link InternetProtocol}
+ * @param port the {@link #getPort() port number}
+ * @param protocol the {@link InternetProtocol}
*/
public ExposedPort(int port, InternetProtocol protocol) {
this.port = port;
@@ -40,8 +38,7 @@ public ExposedPort(int port, InternetProtocol protocol) {
/**
* Creates an {@link ExposedPort} for the given {@link #getPort() port number} and {@link InternetProtocol#DEFAULT}.
*
- * @param port
- * the {@link #getPort() port number}
+ * @param port the {@link #getPort() port number}
*/
public ExposedPort(int port) {
this(port, InternetProtocol.DEFAULT);
@@ -50,10 +47,8 @@ public ExposedPort(int port) {
/**
* Creates an {@link ExposedPort} for the given parameters.
*
- * @param scheme
- * the {@link #getScheme() scheme}, tcp, udp or sctp
- * @param port
- * the {@link #getPort() port number}
+ * @param scheme the {@link #getScheme() scheme}, tcp, udp or sctp
+ * @param port the {@link #getPort() port number}
* @deprecated use {@link #ExposedPort(int, InternetProtocol)}
*/
@Deprecated
@@ -77,7 +72,9 @@ public String getScheme() {
return protocol.toString();
}
- /** @return the port number that the container exposes */
+ /**
+ * @return the port number that the container exposes
+ */
public int getPort() {
return port;
}
@@ -109,11 +106,9 @@ public static ExposedPort sctp(int port) {
/**
* Parses a textual port specification (as used by the Docker CLI) to an {@link ExposedPort}.
*
- * @param serialized
- * the specification, e.g. 80/tcp
+ * @param serialized the specification, e.g. 80/tcp
* @return an {@link ExposedPort} matching the specification
- * @throws IllegalArgumentException
- * if the specification cannot be parsed
+ * @throws IllegalArgumentException if the specification cannot be parsed
*/
@JsonCreator
public static ExposedPort parse(String serialized) throws IllegalArgumentException {
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/model/HealthCheck.java b/docker-java-api/src/main/java/com/github/dockerjava/api/model/HealthCheck.java
index 0e41b873f..bfcf65132 100644
--- a/docker-java-api/src/main/java/com/github/dockerjava/api/model/HealthCheck.java
+++ b/docker-java-api/src/main/java/com/github/dockerjava/api/model/HealthCheck.java
@@ -23,7 +23,6 @@
import java.util.List;
/**
- *
* @author cdancy
*/
@EqualsAndHashCode
@@ -71,6 +70,7 @@ public Long getTimeout() {
/**
* Set interval in nanoseconds
+ *
* @return this {@link HealthCheck} instance
*/
public HealthCheck withInterval(Long interval) {
@@ -80,6 +80,7 @@ public HealthCheck withInterval(Long interval) {
/**
* Set timeout in nanoseconds
+ *
* @return this {@link HealthCheck} instance
*/
public HealthCheck withTimeout(Long timeout) {
@@ -111,6 +112,7 @@ public Long getStartPeriod() {
/**
* Set startPeriod in nanoseconds
+ *
* @return this {@link HealthCheck} instance
*/
public HealthCheck withStartPeriod(Long startPeriod) {
@@ -124,6 +126,7 @@ public Long getStartInterval() {
/**
* Set startInterval in nanoseconds
+ *
* @return this {@link HealthCheck} instance
*/
public HealthCheck withStartInterval(Long startInterval) {
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/model/Identifier.java b/docker-java-api/src/main/java/com/github/dockerjava/api/model/Identifier.java
index a690548b4..1a7959b58 100644
--- a/docker-java-api/src/main/java/com/github/dockerjava/api/model/Identifier.java
+++ b/docker-java-api/src/main/java/com/github/dockerjava/api/model/Identifier.java
@@ -28,9 +28,7 @@ public Identifier(Repository repository, String tag) {
* Return an identifier that correctly splits up the repository and tag. There can be > 1 ":" fred/jim --> fred/jim, []
* fred/jim:123 --> fred/jim, 123 fred:123/jim:123 --> fred:123/jim, 123
*
- *
- * @param identifier
- * as a string
+ * @param identifier as a string
* @return parsed identifier.
*/
public static Identifier fromCompoundString(String identifier) {
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/model/Image.java b/docker-java-api/src/main/java/com/github/dockerjava/api/model/Image.java
index 732dcfe4f..6c9b1c099 100644
--- a/docker-java-api/src/main/java/com/github/dockerjava/api/model/Image.java
+++ b/docker-java-api/src/main/java/com/github/dockerjava/api/model/Image.java
@@ -1,7 +1,6 @@
package com.github.dockerjava.api.model;
import com.fasterxml.jackson.annotation.JsonProperty;
-
import lombok.EqualsAndHashCode;
import lombok.ToString;
@@ -9,9 +8,7 @@
import java.util.Map;
/**
- *
* @author Konstantin Pelykh (kpelykh@gmail.com)
- *
*/
@EqualsAndHashCode
@ToString
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/model/Link.java b/docker-java-api/src/main/java/com/github/dockerjava/api/model/Link.java
index 4b9b27acf..ca6ee32aa 100644
--- a/docker-java-api/src/main/java/com/github/dockerjava/api/model/Link.java
+++ b/docker-java-api/src/main/java/com/github/dockerjava/api/model/Link.java
@@ -22,10 +22,8 @@ public class Link extends DockerObject implements Serializable {
/**
* Creates a {@link Link} for the container with the given name and an aliased name for use in the target container.
*
- * @param name
- * the name of the container that you want to link into the target container
- * @param alias
- * the aliased name under which the linked container will be available in the target container
+ * @param name the name of the container that you want to link into the target container
+ * @param alias the aliased name under which the linked container will be available in the target container
*/
public Link(final String name, final String alias) {
this.name = name;
@@ -49,11 +47,9 @@ public String getAlias() {
/**
* Parses a textual link specification (as used by the Docker CLI) to a {@link Link}.
*
- * @param serialized
- * the specification, e.g. name:alias or /name1:/name2/alias
+ * @param serialized the specification, e.g. name:alias or /name1:/name2/alias
* @return a {@link Link} matching the specification
- * @throws IllegalArgumentException
- * if the specification cannot be parsed
+ * @throws IllegalArgumentException if the specification cannot be parsed
*/
public static Link parse(final String serialized) throws IllegalArgumentException {
try {
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/model/Links.java b/docker-java-api/src/main/java/com/github/dockerjava/api/model/Links.java
index 18bfc75ba..766b0b9de 100644
--- a/docker-java-api/src/main/java/com/github/dockerjava/api/model/Links.java
+++ b/docker-java-api/src/main/java/com/github/dockerjava/api/model/Links.java
@@ -1,12 +1,12 @@
package com.github.dockerjava.api.model;
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonValue;
+
import java.io.Serializable;
import java.util.List;
import java.util.stream.Stream;
-import com.fasterxml.jackson.annotation.JsonCreator;
-import com.fasterxml.jackson.annotation.JsonValue;
-
public class Links implements Serializable {
private static final long serialVersionUID = 1L;
@@ -27,7 +27,7 @@ public Link[] getLinks() {
@JsonCreator
public static Links fromPrimitive(String[] links) {
return new Links(
- Stream.of(links).map(Link::parse).toArray(Link[]::new)
+ Stream.of(links).map(Link::parse).toArray(Link[]::new)
);
}
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/model/Ports.java b/docker-java-api/src/main/java/com/github/dockerjava/api/model/Ports.java
index 0411ca218..839ad627a 100644
--- a/docker-java-api/src/main/java/com/github/dockerjava/api/model/Ports.java
+++ b/docker-java-api/src/main/java/com/github/dockerjava/api/model/Ports.java
@@ -59,7 +59,7 @@ public void bind(ExposedPort exposedPort, Binding binding) {
if (binding == null) {
ports.put(exposedPort, null);
} else {
- ports.put(exposedPort, new Binding[] {binding});
+ ports.put(exposedPort, new Binding[]{binding});
}
}
}
@@ -182,7 +182,7 @@ public Binding(String hostIp, String hostPortSpec) {
/**
* @return the IP address on the Docker host. May be null, in which case Docker will bind the port to all interfaces (
- * 0.0.0.0).
+ * 0.0.0.0).
*/
public String getHostIp() {
return hostIp;
@@ -190,7 +190,7 @@ public String getHostIp() {
/**
* @return the port spec for the binding on the Docker host. May reference a single port ("1234"), a port range ("1234-2345") or
- * null, in which case Docker will dynamically assign a port.
+ * null, in which case Docker will dynamically assign a port.
*/
public String getHostPortSpec() {
return hostPortSpec;
@@ -201,11 +201,9 @@ public String getHostPortSpec() {
*
* Legal syntax: IP|IP:portSpec|portSpec where portSpec is either a single port or a port range
*
- * @param serialized
- * serialized the specification, e.g. 127.0.0.1:80
+ * @param serialized serialized the specification, e.g. 127.0.0.1:80
* @return a {@link Binding} matching the specification
- * @throws IllegalArgumentException
- * if the specification cannot be parsed
+ * @throws IllegalArgumentException if the specification cannot be parsed
*/
public static Binding parse(String serialized) throws IllegalArgumentException {
try {
@@ -269,19 +267,19 @@ public static Ports fromPrimitive(Map