Repository: mina-sshd Updated Branches: refs/heads/master ace6c9fed -> c7f3a3d83
Minor Javadoc comments fixes Project: http://git-wip-us.apache.org/repos/asf/mina-sshd/repo Commit: http://git-wip-us.apache.org/repos/asf/mina-sshd/commit/c7f3a3d8 Tree: http://git-wip-us.apache.org/repos/asf/mina-sshd/tree/c7f3a3d8 Diff: http://git-wip-us.apache.org/repos/asf/mina-sshd/diff/c7f3a3d8 Branch: refs/heads/master Commit: c7f3a3d83a5d998310630d5916d8ec6a36ca90e1 Parents: f1cc850 Author: Lyor Goldstein <[email protected]> Authored: Mon Jul 9 21:12:37 2018 +0300 Committer: Goldstein Lyor <[email protected]> Committed: Tue Jul 10 07:24:51 2018 +0300 ---------------------------------------------------------------------- .../java/org/apache/sshd/client/future/AuthFuture.java | 2 +- .../org/apache/sshd/client/future/ConnectFuture.java | 2 +- .../java/org/apache/sshd/client/future/OpenFuture.java | 2 +- .../apache/sshd/common/future/KeyExchangeFuture.java | 2 +- .../java/org/apache/sshd/common/io/IoReadFuture.java | 2 +- .../main/java/org/apache/sshd/common/io/IoSession.java | 10 +++++----- .../java/org/apache/sshd/common/session/Session.java | 12 ++++++------ .../java/org/apache/sshd/common/util/GenericUtils.java | 6 +++--- .../org/apache/sshd/common/util/io/der/ASN1Class.java | 4 ++-- .../org/apache/sshd/common/util/io/der/ASN1Type.java | 4 ++-- .../apache/sshd/common/util/net/SshdSocketAddress.java | 2 +- 11 files changed, 24 insertions(+), 24 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/c7f3a3d8/sshd-core/src/main/java/org/apache/sshd/client/future/AuthFuture.java ---------------------------------------------------------------------- diff --git a/sshd-core/src/main/java/org/apache/sshd/client/future/AuthFuture.java b/sshd-core/src/main/java/org/apache/sshd/client/future/AuthFuture.java index cf9f802..b5fa1cd 100644 --- a/sshd-core/src/main/java/org/apache/sshd/client/future/AuthFuture.java +++ b/sshd-core/src/main/java/org/apache/sshd/client/future/AuthFuture.java @@ -30,7 +30,7 @@ public interface AuthFuture extends SshFuture<AuthFuture>, VerifiableFuture<Auth /** * Returns the cause of the authentication failure. * - * @return <code>null</code> if the authentication operation is not finished yet, + * @return {@code null} if the authentication operation is not finished yet, * or if the connection attempt is successful (use {@link #isDone()} to distinguish * between the two). */ http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/c7f3a3d8/sshd-core/src/main/java/org/apache/sshd/client/future/ConnectFuture.java ---------------------------------------------------------------------- diff --git a/sshd-core/src/main/java/org/apache/sshd/client/future/ConnectFuture.java b/sshd-core/src/main/java/org/apache/sshd/client/future/ConnectFuture.java index 9c73009..a69095d 100644 --- a/sshd-core/src/main/java/org/apache/sshd/client/future/ConnectFuture.java +++ b/sshd-core/src/main/java/org/apache/sshd/client/future/ConnectFuture.java @@ -56,7 +56,7 @@ public interface ConnectFuture extends SshFuture<ConnectFuture>, VerifiableFutur /** * Returns the cause of the connection failure. * - * @return <code>null</code> if the connect operation is not finished yet, + * @return {@code null} if the connect operation is not finished yet, * or if the connection attempt is successful (use {@link #isDone()} to * distinguish between the two) */ http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/c7f3a3d8/sshd-core/src/main/java/org/apache/sshd/client/future/OpenFuture.java ---------------------------------------------------------------------- diff --git a/sshd-core/src/main/java/org/apache/sshd/client/future/OpenFuture.java b/sshd-core/src/main/java/org/apache/sshd/client/future/OpenFuture.java index e5cfe71..2fe780c 100644 --- a/sshd-core/src/main/java/org/apache/sshd/client/future/OpenFuture.java +++ b/sshd-core/src/main/java/org/apache/sshd/client/future/OpenFuture.java @@ -30,7 +30,7 @@ public interface OpenFuture extends SshFuture<OpenFuture>, VerifiableFuture<Open /** * Returns the cause of the connection failure. * - * @return <code>null</code> if the connect operation is not finished yet, + * @return {@code null} if the connect operation is not finished yet, * or if the connection attempt is successful (use {@link #isDone()} to * distinguish between the two). */ http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/c7f3a3d8/sshd-core/src/main/java/org/apache/sshd/common/future/KeyExchangeFuture.java ---------------------------------------------------------------------- diff --git a/sshd-core/src/main/java/org/apache/sshd/common/future/KeyExchangeFuture.java b/sshd-core/src/main/java/org/apache/sshd/common/future/KeyExchangeFuture.java index 933bbf0..dfab484 100644 --- a/sshd-core/src/main/java/org/apache/sshd/common/future/KeyExchangeFuture.java +++ b/sshd-core/src/main/java/org/apache/sshd/common/future/KeyExchangeFuture.java @@ -26,7 +26,7 @@ public interface KeyExchangeFuture extends SshFuture<KeyExchangeFuture>, Verifia /** * Returns the cause of the exchange failure. * - * @return <code>null</code> if the exchange operation is not finished yet, + * @return {@code null} if the exchange operation is not finished yet, * or if the connection attempt is successful (use {@link #isDone()} to * distinguish between the two). */ http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/c7f3a3d8/sshd-core/src/main/java/org/apache/sshd/common/io/IoReadFuture.java ---------------------------------------------------------------------- diff --git a/sshd-core/src/main/java/org/apache/sshd/common/io/IoReadFuture.java b/sshd-core/src/main/java/org/apache/sshd/common/io/IoReadFuture.java index e127eee..9b27806 100644 --- a/sshd-core/src/main/java/org/apache/sshd/common/io/IoReadFuture.java +++ b/sshd-core/src/main/java/org/apache/sshd/common/io/IoReadFuture.java @@ -33,7 +33,7 @@ public interface IoReadFuture extends SshFuture<IoReadFuture>, VerifiableFuture< /** * Returns the cause of the read failure. * - * @return <code>null</code> if the read operation is not finished yet, + * @return {@code null} if the read operation is not finished yet, * or if the read attempt is successful (use {@link #isDone()} to * distinguish between the two). */ http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/c7f3a3d8/sshd-core/src/main/java/org/apache/sshd/common/io/IoSession.java ---------------------------------------------------------------------- diff --git a/sshd-core/src/main/java/org/apache/sshd/common/io/IoSession.java b/sshd-core/src/main/java/org/apache/sshd/common/io/IoSession.java index 489eda7..3a3545c 100644 --- a/sshd-core/src/main/java/org/apache/sshd/common/io/IoSession.java +++ b/sshd-core/src/main/java/org/apache/sshd/common/io/IoSession.java @@ -25,8 +25,8 @@ import org.apache.sshd.common.Closeable; public interface IoSession extends PacketWriter, Closeable { /** - * @return a unique identifier for this session. Every session has its own - * ID which is different from each other. + * @return a unique identifier for this session. Every session has its own + * ID which is different from any other. */ long getId(); @@ -43,13 +43,13 @@ public interface IoSession extends PacketWriter, Closeable { * * @param key the key of the attribute * @param value the value of the attribute - * @return The old value of the attribute. {@code null} if it is new. + * @return The old value of the attribute - {@code null} if it is new. */ Object setAttribute(Object key, Object value); /** * Sets a user defined attribute if the attribute with the specified key - * is not set yet. This method is same with the following code except + * is not set yet. This method is same with the following code except * that the operation is performed atomically. * <code><pre> * if (containsAttribute(key)) { @@ -61,7 +61,7 @@ public interface IoSession extends PacketWriter, Closeable { * * @param key The key of the attribute we want to set * @param value The value we want to set - * @return The old value of the attribute. {@code null} if not found. + * @return The old value of the attribute - {@code null} if not found. */ Object setAttributeIfAbsent(Object key, Object value); http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/c7f3a3d8/sshd-core/src/main/java/org/apache/sshd/common/session/Session.java ---------------------------------------------------------------------- diff --git a/sshd-core/src/main/java/org/apache/sshd/common/session/Session.java b/sshd-core/src/main/java/org/apache/sshd/common/session/Session.java index ef950ff..def98a3 100644 --- a/sshd-core/src/main/java/org/apache/sshd/common/session/Session.java +++ b/sshd-core/src/main/java/org/apache/sshd/common/session/Session.java @@ -116,8 +116,8 @@ public interface Session /** * Retrieve one of the negotiated values during the KEX stage * - * @param paramType The request {@link KexProposalOption} value - ignored - * if {@code null} + * @param paramType The request {@link KexProposalOption} value + * - ignored if {@code null} * @return The negotiated parameter value - {@code null} if invalid * parameter or no negotiated value */ @@ -128,7 +128,7 @@ public interface Session * key re-exchange executed * * @param incoming If {@code true} then the cipher for the incoming data, - * otherwise for the outgoing data + * otherwise for the outgoing data * @return The {@link CipherInformation} - or {@code null} if not negotiated yet. */ CipherInformation getCipherInformation(boolean incoming); @@ -138,7 +138,7 @@ public interface Session * key re-exchange executed * * @param incoming If {@code true} then the compression for the incoming data, - * otherwise for the outgoing data + * otherwise for the outgoing data * @return The {@link CompressionInformation} - or {@code null} if not negotiated yet. */ CompressionInformation getCompressionInformation(boolean incoming); @@ -148,7 +148,7 @@ public interface Session * key re-exchange executed * * @param incoming If {@code true} then the MAC for the incoming data, - * otherwise for the outgoing data + * otherwise for the outgoing data * @return The {@link MacInformation} - or {@code null} if not negotiated yet. */ MacInformation getMacInformation(boolean incoming); @@ -263,7 +263,7 @@ public interface Session <T extends Service> T getService(Class<T> clazz); /** - * @return the {@link IoSession} associated to this session + * @return The {@link IoSession} associated to this session */ IoSession getIoSession(); http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/c7f3a3d8/sshd-core/src/main/java/org/apache/sshd/common/util/GenericUtils.java ---------------------------------------------------------------------- diff --git a/sshd-core/src/main/java/org/apache/sshd/common/util/GenericUtils.java b/sshd-core/src/main/java/org/apache/sshd/common/util/GenericUtils.java index f22043a..185d26b 100644 --- a/sshd-core/src/main/java/org/apache/sshd/common/util/GenericUtils.java +++ b/sshd-core/src/main/java/org/apache/sshd/common/util/GenericUtils.java @@ -108,7 +108,7 @@ public final class GenericUtils { /** * @param s The {@link String} value to calculate the hash code on - may - * be <code>null</code>/empty in which case a value of zero is returned + * be {@code null}/empty in which case a value of zero is returned * @return The calculated hash code * @see #hashCode(String, Boolean) */ @@ -118,11 +118,11 @@ public final class GenericUtils { /** * @param s The {@link String} value to calculate the hash code on - may - * be <code>null</code>/empty in which case a value of zero is returned + * be {@code null}/empty in which case a value of zero is returned * @param useUppercase Whether to convert the string to uppercase, lowercase * or not at all: * <UL> - * <LI><code>null</code> - no conversion</LI> + * <LI>{@code null} - no conversion</LI> * <LI>{@link Boolean#TRUE} - get hash code of uppercase</LI> * <LI>{@link Boolean#FALSE} - get hash code of lowercase</LI> * </UL> http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/c7f3a3d8/sshd-core/src/main/java/org/apache/sshd/common/util/io/der/ASN1Class.java ---------------------------------------------------------------------- diff --git a/sshd-core/src/main/java/org/apache/sshd/common/util/io/der/ASN1Class.java b/sshd-core/src/main/java/org/apache/sshd/common/util/io/der/ASN1Class.java index 81f1db0..b8351f1 100644 --- a/sshd-core/src/main/java/org/apache/sshd/common/util/io/der/ASN1Class.java +++ b/sshd-core/src/main/java/org/apache/sshd/common/util/io/der/ASN1Class.java @@ -71,7 +71,7 @@ public enum ASN1Class { *------------------------------------------------- * </pre> * @param value The original DER encoded byte - * @return The {@link ASN1Class} value - <code>null</code> if no match found + * @return The {@link ASN1Class} value - {@code null} if no match found * @see #fromTypeValue(int) */ public static ASN1Class fromDERValue(int value) { @@ -80,7 +80,7 @@ public enum ASN1Class { /** * @param value The "pure" value - unshifted and with no extras - * @return The {@link ASN1Class} value - <code>null</code> if no match found + * @return The {@link ASN1Class} value - {@code null} if no match found */ public static ASN1Class fromTypeValue(int value) { // all 4 values are defined http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/c7f3a3d8/sshd-core/src/main/java/org/apache/sshd/common/util/io/der/ASN1Type.java ---------------------------------------------------------------------- diff --git a/sshd-core/src/main/java/org/apache/sshd/common/util/io/der/ASN1Type.java b/sshd-core/src/main/java/org/apache/sshd/common/util/io/der/ASN1Type.java index a512ab2..3dd13ca 100644 --- a/sshd-core/src/main/java/org/apache/sshd/common/util/io/der/ASN1Type.java +++ b/sshd-core/src/main/java/org/apache/sshd/common/util/io/der/ASN1Type.java @@ -91,7 +91,7 @@ public enum ASN1Type { *------------------------------------------------- * </pre> * @param value The original DER encoded byte - * @return The {@link ASN1Type} value - <code>null</code> if no match found + * @return The {@link ASN1Type} value - {@code null} if no match found * @see #fromTypeValue(int) */ public static ASN1Type fromDERValue(int value) { @@ -100,7 +100,7 @@ public enum ASN1Type { /** * @param value The "pure" type value - with no extra bits set - * @return The {@link ASN1Type} value - <code>null</code> if no match found + * @return The {@link ASN1Type} value - {@code null} if no match found */ public static ASN1Type fromTypeValue(int value) { if ((value < 0) || (value > 0x1F)) { // only 5 bits are used http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/c7f3a3d8/sshd-core/src/main/java/org/apache/sshd/common/util/net/SshdSocketAddress.java ---------------------------------------------------------------------- diff --git a/sshd-core/src/main/java/org/apache/sshd/common/util/net/SshdSocketAddress.java b/sshd-core/src/main/java/org/apache/sshd/common/util/net/SshdSocketAddress.java index 9e51bd9..3a40d20 100644 --- a/sshd-core/src/main/java/org/apache/sshd/common/util/net/SshdSocketAddress.java +++ b/sshd-core/src/main/java/org/apache/sshd/common/util/net/SshdSocketAddress.java @@ -245,7 +245,7 @@ public class SshdSocketAddress extends SocketAddress { * @param addr The {@link InetAddress} to be verified * @return <P><code>true</code> if the address is:</P></BR> * <UL> - * <LI>Not <code>null</code></LI> + * <LI>Not {@code null}</LI> * <LI>An {@link Inet4Address}</LI> * <LI>Not link local</LI> * <LI>Not a multicast</LI>
