Skip to content

Commit

Permalink
#1644 names simplified
Browse files Browse the repository at this point in the history
  • Loading branch information
yegor256 committed Jul 15, 2022
1 parent ddb681e commit a890c71
Show file tree
Hide file tree
Showing 20 changed files with 29 additions and 25 deletions.
2 changes: 1 addition & 1 deletion src/main/java/org/cactoos/bytes/Base64Bytes.java
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ public final class Base64Bytes implements Bytes {
private final Base64.Decoder decoder;

/**
* Ctor uses a RFC4648 {@link java.util.Base64.Decoder}.
* Ctor uses a RFC4648 {@link Base64.Decoder}.
*
* @param origin Origin bytes
*/
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/cactoos/bytes/BytesBase64.java
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ public final class BytesBase64 implements Bytes {
private final Base64.Encoder encoder;

/**
* Ctor uses a RFC4648 {@link java.util.Base64.Encoder}.
* Ctor uses a RFC4648 {@link Base64.Encoder}.
*
* @param origin Origin bytes.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/cactoos/bytes/IoCheckedBytes.java
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@

/**
* Bytes that doesn't throw checked {@link Exception},
* but only throws {@link java.io.IOException}.
* but only throws {@link IOException}.
*
* <p>There is no thread-safety guarantee.
*
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/cactoos/collection/Immutable.java
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
* @param <X> Type of source item
* @since 1.16
* @todo #898:30min Replace all the Collections.unmodifiableCollection
* with the {@link org.cactoos.collection.Immutable} from the cactoos codebase.
* with the {@link Immutable} from the cactoos codebase.
* That should be done because Elegant Object principles are against static methods.
*/
@SuppressWarnings(
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/org/cactoos/iterable/IterableOf.java
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
*/
package org.cactoos.iterable;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.util.Iterator;
import org.cactoos.Fallback;
import org.cactoos.Scalar;
Expand Down Expand Up @@ -84,7 +85,7 @@ public Iterator<X> iterator() {
}

@Override
@edu.umd.cs.findbugs.annotations.SuppressFBWarnings("EQ_UNUSUAL")
@SuppressFBWarnings("EQ_UNUSUAL")
@SuppressWarnings (value = "unchecked")
public boolean equals(final Object other) {
return new Unchecked<>(
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/cactoos/proc/ForEach.java
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@
import org.cactoos.scalar.And;

/**
* Executes a {@link org.cactoos.Proc} for each element of an
* {@link java.lang.Iterable}
* Executes a {@link Proc} for each element of an
* {@link Iterable}
*
* <p>
* This class can be effectively used to iterate through a collection, just like
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/cactoos/proc/ForEachInThreads.java
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@
import org.cactoos.scalar.AndInThreads;

/**
* Executes a {@link org.cactoos.Proc} in a new Thread for each element of an
* {@link java.lang.Iterable}
* Executes a {@link Proc} in a new Thread for each element of an
* {@link Iterable}
*
* <p>
* This class can be effectively used to iterate through a collection, just like
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/cactoos/proc/ForEachWithIndex.java
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@
import org.cactoos.scalar.AndWithIndex;

/**
* Executes a {@link org.cactoos.BiProc} for each element of an
* {@link java.lang.Iterable}
* Executes a {@link BiProc} for each element of an
* {@link Iterable}
*
* <p>
* This class can be effectively used to iterate through a collection similar to how
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/cactoos/proc/IoCheckedProc.java
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@

/**
* Proc that doesn't throw checked {@link Exception}, but
* throws {@link java.io.IOException} instead.
* throws {@link IOException} instead.
*
* <p>There is no thread-safety guarantee.
*
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/org/cactoos/scalar/Retry.java
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ public Retry(final Scalar<? extends T> scalar) {
/**
* Ctor.
* @param scalar Scalar original
* @param wait The {@link java.time.Duration} to wait between attempts
* @param wait The {@link Duration} to wait between attempts
*/
public Retry(final Scalar<? extends T> scalar, final Duration wait) {
// @checkstyle MagicNumberCheck (1 line)
Expand All @@ -101,7 +101,7 @@ public Retry(final Scalar<? extends T> scalar, final int attempts) {
* Ctor.
* @param scalar Scalar original
* @param attempts Maximum number of attempts
* @param wait The {@link java.time.Duration} to wait between attempts
* @param wait The {@link Duration} to wait between attempts
*/
public Retry(final Scalar<? extends T> scalar, final int attempts,
final Duration wait) {
Expand All @@ -122,7 +122,7 @@ public Retry(final Scalar<? extends T> scalar,
* Ctor.
* @param scalar Func original
* @param exit Exit condition, returns TRUE if there is no reason to try
* @param wait The {@link java.time.Duration} to wait between attempts
* @param wait The {@link Duration} to wait between attempts
*/
public Retry(final Scalar<? extends T> scalar,
final Func<Integer, Boolean> exit, final Duration wait) {
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/cactoos/text/Replaced.java
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ public Replaced(
* Ctor.
* <p>
* The given {@link Pattern regex} is used to produce a
* {@link Pattern#matcher(java.lang.CharSequence) matcher} that will be
* {@link Pattern#matcher(CharSequence) matcher} that will be
* transformed by {@code func} into a replacement string to replace each
* {@link Matcher#find() matching} substring.
* <p>
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/org/cactoos/text/TextOfScalar.java
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
*/
package org.cactoos.text;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import org.cactoos.Scalar;
import org.cactoos.Text;
import org.cactoos.scalar.And;
Expand Down Expand Up @@ -68,7 +69,7 @@ public int hashCode() {
}

@Override
@edu.umd.cs.findbugs.annotations.SuppressFBWarnings("EQ_UNUSUAL")
@SuppressFBWarnings("EQ_UNUSUAL")
public boolean equals(final Object obj) {
return new Unchecked<>(
new Or(
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/org/cactoos/text/TextOfString.java
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
*/
package org.cactoos.text;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import org.cactoos.Text;
import org.cactoos.scalar.And;
import org.cactoos.scalar.Or;
Expand Down Expand Up @@ -67,7 +68,7 @@ public int hashCode() {
}

@Override
@edu.umd.cs.findbugs.annotations.SuppressFBWarnings("EQ_UNUSUAL")
@SuppressFBWarnings("EQ_UNUSUAL")
public boolean equals(final Object obj) {
return new Unchecked<>(
new Or(
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/org/cactoos/text/UncheckedText.java
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
*/
package org.cactoos.text;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import org.cactoos.Func;
import org.cactoos.Text;
import org.cactoos.func.UncheckedFunc;
Expand Down Expand Up @@ -102,7 +103,7 @@ public String toString() {
}

@Override
@edu.umd.cs.findbugs.annotations.SuppressFBWarnings("EQ_UNUSUAL")
@SuppressFBWarnings("EQ_UNUSUAL")
public boolean equals(final Object obj) {
return new Unchecked<>(
new Or(
Expand Down
2 changes: 1 addition & 1 deletion src/test/java/org/cactoos/bytes/Base64BytesTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
import org.llorllale.cactoos.matchers.Assertion;

/**
* Test case for {@link org.cactoos.bytes.Base64Bytes}.
* Test case for {@link Base64Bytes}.
*
* @since 0.20.2
* @checkstyle JavadocMethodCheck (500 lines)
Expand Down
2 changes: 1 addition & 1 deletion src/test/java/org/cactoos/bytes/BytesBase64Test.java
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
import org.llorllale.cactoos.matchers.Assertion;

/**
* Test case for {@link org.cactoos.bytes.BytesBase64}.
* Test case for {@link BytesBase64}.
* @since 0.20.2
* @checkstyle JavadocMethodCheck (500 lines)
*/
Expand Down
2 changes: 1 addition & 1 deletion src/test/java/org/cactoos/io/GzipInputTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
import org.llorllale.cactoos.matchers.IsText;

/**
* Test case for {@link org.cactoos.io.GzipInput}.
* Test case for {@link GzipInput}.
* @since 0.29
* @checkstyle JavadocMethodCheck (500 lines)
* @checkstyle ClassDataAbstractionCouplingCheck (500 lines)
Expand Down
2 changes: 1 addition & 1 deletion src/test/java/org/cactoos/io/GzipOutputTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
import org.llorllale.cactoos.matchers.Assertion;

/**
* Test case for {@link org.cactoos.io.GzipOutput}.
* Test case for {@link GzipOutput}.
* @checkstyle JavadocMethodCheck (500 lines)
* @checkstyle ClassDataAbstractionCouplingCheck (500 lines)
* @since 0.29
Expand Down
2 changes: 1 addition & 1 deletion src/test/java/org/cactoos/iterator/MappedTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
import org.llorllale.cactoos.matchers.Throws;

/**
* Tests for {@link org.cactoos.iterator.Mapped}.
* Tests for {@link Mapped}.
*
* @since 0.47
*/
Expand Down
2 changes: 1 addition & 1 deletion src/test/java/org/cactoos/list/JoinedTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
import org.llorllale.cactoos.matchers.IsTrue;

/**
* Test case for {@link org.cactoos.list.Joined}.
* Test case for {@link Joined}.
*
* @since 0.20
* @checkstyle JavadocMethodCheck (500 lines)
Expand Down

0 comments on commit a890c71

Please sign in to comment.