From 4b4f6bffd6bc01ae59219922a4695a3fef44b210 Mon Sep 17 00:00:00 2001 From: Robert Varga Date: Tue, 1 Aug 2017 11:22:18 +0200 Subject: [PATCH] Fix/suppress checkstyle warnings Some of the argument names are coming from superclasses, add suppression of those. Others can be easily renamed. Change-Id: I75e746287fc2278790091185d967dfcc2d16d94e Signed-off-by: Robert Varga --- .../yangtools/triemap/AbstractEntrySet.java | 1 + .../yangtools/triemap/AbstractKeySet.java | 3 ++ .../opendaylight/yangtools/triemap/CNode.java | 2 +- .../yangtools/triemap/EntryUtil.java | 6 ++-- .../opendaylight/yangtools/triemap/INode.java | 30 +++++++++---------- .../yangtools/triemap/ImmutableEntrySet.java | 3 ++ .../yangtools/triemap/ImmutableKeySet.java | 3 ++ .../yangtools/triemap/ImmutableTrieMap.java | 1 + .../yangtools/triemap/LNodeEntry.java | 4 +-- .../yangtools/triemap/MutableEntrySet.java | 2 ++ .../yangtools/triemap/MutableIterator.java | 4 +-- .../yangtools/triemap/MutableKeySet.java | 1 + .../opendaylight/yangtools/triemap/SNode.java | 26 ++++++++-------- .../yangtools/triemap/SerializationProxy.java | 2 +- .../opendaylight/yangtools/triemap/TNode.java | 26 ++++++++-------- 15 files changed, 64 insertions(+), 50 deletions(-) diff --git a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/AbstractEntrySet.java b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/AbstractEntrySet.java index c915945d77..7089a7e15a 100644 --- a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/AbstractEntrySet.java +++ b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/AbstractEntrySet.java @@ -40,6 +40,7 @@ abstract class AbstractEntrySet extends AbstractSet> { } @Override + @SuppressWarnings("checkstyle:parameterName") public final boolean contains(final Object o) { if (!(o instanceof Entry)) { return false; diff --git a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/AbstractKeySet.java b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/AbstractKeySet.java index 277156a5b5..ef4f04cd14 100644 --- a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/AbstractKeySet.java +++ b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/AbstractKeySet.java @@ -39,16 +39,19 @@ abstract class AbstractKeySet extends AbstractSet { } @Override + @SuppressWarnings("checkstyle:parameterName") public final boolean add(final K e) { throw new UnsupportedOperationException(); } @Override + @SuppressWarnings("checkstyle:parameterName") public final boolean addAll(final Collection c) { throw new UnsupportedOperationException(); } @Override + @SuppressWarnings("checkstyle:parameterName") public final boolean contains(final Object o) { return map.containsKey(o); } diff --git a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/CNode.java b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/CNode.java index f6f95298f0..12a8fb74ed 100644 --- a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/CNode.java +++ b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/CNode.java @@ -50,7 +50,7 @@ final class CNode extends MainNode { private static MainNode dual(final SNode x, final int xhc, final SNode y, final int yhc, final int lev, final Gen gen) { if (lev >= HASH_BITS) { - return new LNode<>(x.k, x.v, y.k, y.v); + return new LNode<>(x.key, x.value, y.key, y.value); } final int xidx = (xhc >>> lev) & 0x1f; diff --git a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/EntryUtil.java b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/EntryUtil.java index a73797eff3..6fe50d5597 100644 --- a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/EntryUtil.java +++ b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/EntryUtil.java @@ -30,12 +30,12 @@ final class EntryUtil { /** * Utility implementing {@link Entry#equals(Object)}. */ - static boolean equal(final Object o, final Object key, final Object value) { - if (!(o instanceof Entry)) { + static boolean equal(final Object obj, final Object key, final Object value) { + if (!(obj instanceof Entry)) { return false; } - final Entry e = (Entry)o; + final Entry e = (Entry)obj; return key.equals(e.getKey()) && value.equals(e.getValue()); } diff --git a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/INode.java b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/INode.java index 23046ed0e8..3e159173ff 100644 --- a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/INode.java +++ b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/INode.java @@ -161,7 +161,7 @@ final class INode extends BasicNode { return false; } else if (cnAtPos instanceof SNode) { final SNode sn = (SNode) cnAtPos; - if (sn.hc == hc && ct.equal(sn.k, k)) { + if (sn.hc == hc && ct.equal(sn.key, k)) { return GCAS(cn, cn.updatedAt(pos, new SNode<>(k, v, hc), gen), ct); } @@ -253,9 +253,9 @@ final class INode extends BasicNode { } else if (cnAtPos instanceof SNode) { final SNode sn = (SNode) cnAtPos; if (cond == null) { - if (sn.hc == hc && ct.equal(sn.k, k)) { + if (sn.hc == hc && ct.equal(sn.key, k)) { if (GCAS(cn, cn.updatedAt(pos, new SNode<>(k, v, hc), gen), ct)) { - return Optional.of(sn.v); + return Optional.of(sn.value); } return null; @@ -263,24 +263,24 @@ final class INode extends BasicNode { return insertDual(ct, cn, pos, sn, k, v, hc, lev); } else if (cond == ABSENT) { - if (sn.hc == hc && ct.equal(sn.k, k)) { - return Optional.of(sn.v); + if (sn.hc == hc && ct.equal(sn.key, k)) { + return Optional.of(sn.value); } return insertDual(ct, cn, pos, sn, k, v, hc, lev); } else if (cond == PRESENT) { - if (sn.hc == hc && ct.equal(sn.k, k)) { + if (sn.hc == hc && ct.equal(sn.key, k)) { if (GCAS(cn, cn.updatedAt(pos, new SNode<>(k, v, hc), gen), ct)) { - return Optional.of(sn.v); + return Optional.of(sn.value); } return null; } return Optional.empty(); } else { - if (sn.hc == hc && ct.equal(sn.k, k) && cond.equals(sn.v)) { + if (sn.hc == hc && ct.equal(sn.key, k) && cond.equals(sn.value)) { if (GCAS(cn, cn.updatedAt(pos, new SNode<>(k, v, hc), gen), ct)) { - return Optional.of(sn.v); + return Optional.of(sn.value); } return null; @@ -394,8 +394,8 @@ final class INode extends BasicNode { } else if (sub instanceof SNode) { // 2) singleton node final SNode sn = (SNode) sub; - if (sn.hc == hc && ct.equal(sn.k, k)) { - return sn.v; + if (sn.hc == hc && ct.equal(sn.key, k)) { + return sn.value; } return null; @@ -418,8 +418,8 @@ final class INode extends BasicNode { private Object cleanReadOnly(final TNode tn, final int lev, final INode parent, final TrieMap ct, final K k, final int hc) { if (ct.isReadOnly()) { - if (tn.hc == hc && ct.equal(tn.k, k)) { - return tn.v; + if (tn.hc == hc && ct.equal(tn.key, k)) { + return tn.value; } return null; @@ -475,10 +475,10 @@ final class INode extends BasicNode { } } else if (sub instanceof SNode) { final SNode sn = (SNode) sub; - if (sn.hc == hc && ct.equal(sn.k, k) && (cond == null || cond.equals(sn.v))) { + if (sn.hc == hc && ct.equal(sn.key, k) && (cond == null || cond.equals(sn.value))) { final MainNode ncn = cn.removedAt(pos, flag, gen).toContracted(lev); if (GCAS(cn, ncn, ct)) { - res = Optional.of(sn.v); + res = Optional.of(sn.value); } else { res = null; } diff --git a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/ImmutableEntrySet.java b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/ImmutableEntrySet.java index 9f031405e3..141f42c245 100644 --- a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/ImmutableEntrySet.java +++ b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/ImmutableEntrySet.java @@ -45,16 +45,19 @@ final class ImmutableEntrySet extends AbstractEntrySet { } @Override + @SuppressWarnings("checkstyle:parameterName") public boolean remove(final Object o) { throw unsupported(); } @Override + @SuppressWarnings("checkstyle:parameterName") public boolean removeAll(final Collection c) { throw unsupported(); } @Override + @SuppressWarnings("checkstyle:parameterName") public boolean retainAll(final Collection c) { throw unsupported(); } diff --git a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/ImmutableKeySet.java b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/ImmutableKeySet.java index a25649e777..8cfbfecff2 100644 --- a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/ImmutableKeySet.java +++ b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/ImmutableKeySet.java @@ -45,16 +45,19 @@ final class ImmutableKeySet extends AbstractKeySet { } @Override + @SuppressWarnings("checkstyle:parameterName") public boolean remove(final Object o) { throw unsupported(); } @Override + @SuppressWarnings("checkstyle:parameterName") public boolean retainAll(final Collection c) { throw unsupported(); } @Override + @SuppressWarnings("checkstyle:parameterName") public boolean removeAll(final Collection c) { throw unsupported(); } diff --git a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/ImmutableTrieMap.java b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/ImmutableTrieMap.java index f3f63be424..79664bf63a 100644 --- a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/ImmutableTrieMap.java +++ b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/ImmutableTrieMap.java @@ -74,6 +74,7 @@ public final class ImmutableTrieMap extends TrieMap { } @Override + @SuppressWarnings("checkstyle:parameterName") public void putAll(final Map m) { throw unsupported(); } diff --git a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/LNodeEntry.java b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/LNodeEntry.java index d20ea18dd0..6a72ccaae4 100644 --- a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/LNodeEntry.java +++ b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/LNodeEntry.java @@ -58,8 +58,8 @@ abstract class LNodeEntry implements Entry { @SuppressFBWarnings(value = "EQ_UNUSUAL", justification = "Equality handled by utility methods") @Override - public final boolean equals(final Object o) { - return EntryUtil.equal(o, key, value); + public final boolean equals(final Object obj) { + return EntryUtil.equal(obj, key, value); } @Override diff --git a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/MutableEntrySet.java b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/MutableEntrySet.java index c9bdca25c6..04ddb88189 100644 --- a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/MutableEntrySet.java +++ b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/MutableEntrySet.java @@ -32,6 +32,7 @@ final class MutableEntrySet extends AbstractEntrySet { } @Override + @SuppressWarnings("checkstyle:parameterName") public boolean add(final Entry e) { final K k = e.getKey(); checkArgument(k != null); @@ -53,6 +54,7 @@ final class MutableEntrySet extends AbstractEntrySet { } @Override + @SuppressWarnings("checkstyle:parameterName") public boolean remove(final Object o) { if (!(o instanceof Entry)) { return false; diff --git a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/MutableIterator.java b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/MutableIterator.java index 988be4099a..20fb567b90 100644 --- a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/MutableIterator.java +++ b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/MutableIterator.java @@ -111,8 +111,8 @@ final class MutableIterator extends AbstractIterator { @SuppressFBWarnings(value = "EQ_UNUSUAL", justification = "Equality handled by utility methods") @Override - public boolean equals(final Object o) { - return EntryUtil.equal(o, getKey(), getValue()); + public boolean equals(final Object obj) { + return EntryUtil.equal(obj, getKey(), getValue()); } @Override diff --git a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/MutableKeySet.java b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/MutableKeySet.java index f6d5d2c772..9cb72b079f 100644 --- a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/MutableKeySet.java +++ b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/MutableKeySet.java @@ -56,6 +56,7 @@ final class MutableKeySet extends AbstractKeySet { } @Override + @SuppressWarnings("checkstyle:parameterName") public boolean remove(final Object o) { return map().remove(o) != null; } diff --git a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/SNode.java b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/SNode.java index ef3e36a02e..d11a592ea5 100644 --- a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/SNode.java +++ b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/SNode.java @@ -18,26 +18,26 @@ package org.opendaylight.yangtools.triemap; import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; final class SNode extends BasicNode implements EntryNode { - final K k; - final V v; + final K key; + final V value; final int hc; SNode(final K key, final V value, final int hc) { - this.k = key; - this.v = value; + this.key = key; + this.value = value; this.hc = hc; } SNode copy() { - return new SNode<>(k, v, hc); + return new SNode<>(key, value, hc); } TNode copyTombed() { - return new TNode<>(k, v, hc); + return new TNode<>(key, value, hc); } SNode copyUntombed() { - return new SNode<>(k, v, hc); + return new SNode<>(key, value, hc); } @Override @@ -48,27 +48,27 @@ final class SNode extends BasicNode implements EntryNode { @Override public K getKey() { - return k; + return key; } @Override public V getValue() { - return v; + return value; } @Override public int hashCode() { - return EntryUtil.hash(k, v); + return EntryUtil.hash(key, value); } @SuppressFBWarnings(value = "EQ_UNUSUAL", justification = "Equality handled by utility methods") @Override - public boolean equals(final Object o) { - return EntryUtil.equal(o, k, v); + public boolean equals(final Object obj) { + return EntryUtil.equal(obj, key, value); } @Override public String toString() { - return EntryUtil.string(k, v); + return EntryUtil.string(key, value); } } diff --git a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/SerializationProxy.java b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/SerializationProxy.java index 700deacc3d..3557fc4125 100644 --- a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/SerializationProxy.java +++ b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/SerializationProxy.java @@ -38,7 +38,7 @@ final class SerializationProxy implements Externalizable { private TrieMap map; private boolean readOnly; - @SuppressWarnings("checkStyle:redundantModifier") + @SuppressWarnings("checkstyle:redundantModifier") public SerializationProxy() { // For Externalizable } diff --git a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/TNode.java b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/TNode.java index 7a89e21809..591d0b0b79 100644 --- a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/TNode.java +++ b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/TNode.java @@ -18,26 +18,26 @@ package org.opendaylight.yangtools.triemap; import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; final class TNode extends MainNode implements EntryNode { - final K k; - final V v; + final K key; + final V value; final int hc; TNode(final K key, final V value, final int hc) { - this.k = key; - this.v = value; + this.key = key; + this.value = value; this.hc = hc; } TNode copy() { - return new TNode<>(k, v, hc); + return new TNode<>(key, value, hc); } TNode copyTombed() { - return new TNode<>(k, v, hc); + return new TNode<>(key, value, hc); } SNode copyUntombed() { - return new SNode<>(k, v, hc); + return new SNode<>(key, value, hc); } @Override @@ -58,27 +58,27 @@ final class TNode extends MainNode implements EntryNode { @Override public K getKey() { - return k; + return key; } @Override public V getValue() { - return v; + return value; } @Override public int hashCode() { - return EntryUtil.hash(k, v); + return EntryUtil.hash(key, value); } @SuppressFBWarnings(value = "EQ_UNUSUAL", justification = "Equality handled by utility methods") @Override - public boolean equals(final Object o) { - return EntryUtil.equal(o, k, v); + public boolean equals(final Object obj) { + return EntryUtil.equal(obj, key, value); } @Override public String toString() { - return EntryUtil.string(k, v); + return EntryUtil.string(key, value); } } -- 2.36.6