Skip to content

Commit

Permalink
fix javadoc errors
Browse files Browse the repository at this point in the history
  • Loading branch information
PascalSchumacher committed Jan 8, 2017
1 parent 8f273c4 commit 3889a64
Show file tree
Hide file tree
Showing 16 changed files with 36 additions and 40 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ public OffsetDateTimeAssert then(OffsetDateTime actual) {
/**
* Create assertion for {@link java.util.concurrent.CompletableFuture}.
*
* @param future the actual value.
* @param actual the actual value.
* @param <T> the type of the value contained in the {@link java.util.concurrent.CompletableFuture}.
*
* @return the created assertion object.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2211,8 +2211,8 @@ public S filteredOn(Predicate<? super T> predicate) {
* @throws AssertionError if one or more elements don't satisfy the given predicate.
*/
@Override
public S allMatch(Predicate<? super T> condition) {
iterables.assertAllMatch(info, newArrayList(actual), condition, PredicateDescription.GIVEN);
public S allMatch(Predicate<? super T> predicate) {
iterables.assertAllMatch(info, newArrayList(actual), predicate, PredicateDescription.GIVEN);
return myself;
}

Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/assertj/core/api/AbstractPathAssert.java
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
* @see java.nio.file.Paths#get(String, String...)
* @see FileSystem
* @see FileSystem#getPath(String, String...)
* @see FileSystems#getDefault()
* @see java.nio.file.FileSystems#getDefault()
* @see Files
*/
public abstract class AbstractPathAssert<S extends AbstractPathAssert<S>> extends AbstractComparableAssert<S, Path> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ public OffsetDateTimeAssert assertThat(OffsetDateTime actual) {
/**
* Create assertion for {@link java.util.concurrent.CompletableFuture}.
*
* @param future the actual value.
* @param actual the actual value.
* @param <T> the type of the value contained in the {@link java.util.concurrent.CompletableFuture}.
*
* @return the created assertion object.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ public SELF isCloseTo(TEMPORAL other, TemporalOffset<? super TEMPORAL> offset) {
}

/**
* Same assertion as {@link #isCloseTo(TEMPORAL, TemporalOffset)} but the {@code TEMPORAL} is built from a given String that
* Same assertion as {@link #isCloseTo(Temporal, TemporalOffset)} but the {@code TEMPORAL} is built from a given String that
* follows predefined ISO date format <a href=
* "http://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html"
* >Predefined Formatters</a> to allow calling {@link #parse(String)})} method.
Expand Down
5 changes: 2 additions & 3 deletions src/main/java/org/assertj/core/api/Assertions.java
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,6 @@
import org.assertj.core.data.MapEntry;
import org.assertj.core.data.Offset;
import org.assertj.core.data.Percentage;
import org.assertj.core.data.TemporalOffset;
import org.assertj.core.data.TemporalUnitLessThanOffset;
import org.assertj.core.data.TemporalUnitOffset;
import org.assertj.core.data.TemporalUnitWithinOffset;
Expand Down Expand Up @@ -1020,7 +1019,7 @@ public static <VALUE> AtomicStampedReferenceAssert<VALUE> assertThat(AtomicStamp
*
* If the provided {@link ThrowingCallable} does not raise an exception, an error is immediately raised,
* in that case the test description provided with {@link AbstractAssert#as(String, Object...) as(String, Object...)} is not honored.
* To use a test description, use {@link #catchThrowable(ThrowingCallable) catchThrowable} as shown below.
* To use a test description, use {@link #catchThrowable(ThrowableAssert.ThrowingCallable)} as shown below.
* <pre><code class='java'> // assertion will fail but "display me" won't appear in the error
* assertThatThrownBy(() -> { // do nothing }).as("display me").isInstanceOf(Exception.class);
*
Expand Down Expand Up @@ -1073,7 +1072,7 @@ public static Throwable catchThrowable(ThrowingCallable shouldRaiseThrowable) {
* .isThrownBy(() -> { throw new IOException("boom!"); })
* .withMessage("boom!"); </code></pre>
*
* This method is more or less the same of {@link #assertThatThrownBy(ThrowingCallable)} but in a more natural way.
* This method is more or less the same of {@link #assertThatThrownBy(ThrowableAssert.ThrowingCallable)} but in a more natural way.
* @param exceptionType the exception type.
* @return the created {@link ThrowableTypeAssert}.
*/
Expand Down
30 changes: 15 additions & 15 deletions src/main/java/org/assertj/core/api/AssertionsForClassTypes.java
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ public class AssertionsForClassTypes {
/**
* Create assertion for {@link java.util.concurrent.CompletableFuture}.
*
* @param future the actual value.
* @param actual the actual value.
* @param <T> the type of the value contained in the {@link java.util.concurrent.CompletableFuture}.
*
* @return the created assertion object.
Expand All @@ -86,7 +86,7 @@ public static <T> CompletableFutureAssert<T> assertThat(CompletableFuture<T> act
/**
* Create assertion for {@link java.util.Optional}.
*
* @param optional the actual value.
* @param actual the actual value.
* @param <T> the type of the value contained in the {@link java.util.Optional}.
*
* @return the created assertion object.
Expand All @@ -99,7 +99,7 @@ public static <T> OptionalAssert<T> assertThat(Optional<T> actual) {
/**
* Create assertion for {@link java.util.OptionalDouble}.
*
* @param optionalDouble the actual value.
* @param actual the actual value.
*
* @return the created assertion object.
*/
Expand All @@ -111,7 +111,7 @@ public static OptionalDoubleAssert assertThat(OptionalDouble actual) {
/**
* Create assertion for {@link java.util.OptionalInt}.
*
* @param optionalInt the actual value.
* @param actual the actual value.
*
* @return the created assertion object.
*/
Expand All @@ -123,7 +123,7 @@ public static OptionalIntAssert assertThat(OptionalInt actual) {
/**
* Create assertion for {@link java.util.OptionalInt}.
*
* @param optionalLong the actual value.
* @param actual the actual value.
*
* @return the created assertion object.
*/
Expand Down Expand Up @@ -513,8 +513,8 @@ public static AbstractDateAssert<?> assertThat(Date actual) {
* @return the created assertion object.
*/
@CheckReturnValue
public static AbstractZonedDateTimeAssert<?> assertThat(ZonedDateTime date) {
return new ZonedDateTimeAssert(date);
public static AbstractZonedDateTimeAssert<?> assertThat(ZonedDateTime actual) {
return new ZonedDateTimeAssert(actual);
}

/**
Expand All @@ -524,8 +524,8 @@ public static AbstractZonedDateTimeAssert<?> assertThat(ZonedDateTime date) {
* @return the created assertion object.
*/
@CheckReturnValue
public static AbstractLocalDateTimeAssert<?> assertThat(LocalDateTime localDateTime) {
return new LocalDateTimeAssert(localDateTime);
public static AbstractLocalDateTimeAssert<?> assertThat(LocalDateTime actual) {
return new LocalDateTimeAssert(actual);
}

/**
Expand All @@ -546,8 +546,8 @@ public static AbstractOffsetDateTimeAssert<?> assertThat(OffsetDateTime actual)
* @return the created assertion object.
*/
@CheckReturnValue
public static AbstractOffsetTimeAssert<?> assertThat(OffsetTime offsetTime) {
return new OffsetTimeAssert(offsetTime);
public static AbstractOffsetTimeAssert<?> assertThat(OffsetTime actual) {
return new OffsetTimeAssert(actual);
}

/**
Expand Down Expand Up @@ -615,9 +615,9 @@ public static AbstractLocalDateAssert<?> assertThat(LocalDate localDate) {
* .isThrownBy(() -> { throw new IOException("boom!"); })
* .withMessage("boom!"); </code></pre>
*
* This method is more or less the same of {@link #assertThatThrownBy(ThrowingCallable)} but in a more natural way.
* This method is more or less the same of {@link #assertThatThrownBy(ThrowableAssert.ThrowingCallable)} but in a more natural way.
*
* @param actual the actual value.
* @param exceptionType the actual value.
* @return the created {@link ThrowableTypeAssert}.
*/
@CheckReturnValue
Expand Down Expand Up @@ -813,7 +813,7 @@ public static void setAllowExtractingPrivateFields(boolean allowExtractingPrivat
* <li>
* <code><code>{@link org.assertj.core.api.AbstractIterableAssert#usingElementComparatorOnFields(java.lang.String...)}</code>
* </li>
* <li><code>{@link org.assertj.core.api.AbstractObjectAssert#isEqualToComparingFieldByField(A)}</code></li>
* <li><code>{@link org.assertj.core.api.AbstractObjectAssert#isEqualToComparingFieldByField(Object)}</code></li>
* </ul>
*
* If the value is <code>false</code> and these methods try to compare private fields, it will fail with an exception.
Expand All @@ -829,7 +829,7 @@ public static void setAllowComparingPrivateFields(boolean allowComparingPrivateF
// ------------------------------------------------------------------------------------------------------

/**
* Only delegate to {@link MapEntry#entry(K key, V value)} so that Assertions offers a full feature entry point to
* Only delegate to {@link MapEntry#entry(Object, Object)} so that Assertions offers a full feature entry point to
* all
* AssertJ features (but you can use {@link MapEntry} if you prefer).
* <p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ public AtomicIntegerFieldUpdaterAssert(AtomicIntegerFieldUpdater<OBJECT> actual)
* fieldUpdater.set(person, 28);
* assertThat(fieldUpdater).hasValue(25, person);</code></pre>
*
* @param expectedValue the expected value inside the {@link OBJECT}.
* @param expectedValue the expected value inside the {@code OBJECT}.
* @param obj the object holding the updatable field.
* @return this assertion object.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ public AtomicLongFieldUpdaterAssert(AtomicLongFieldUpdater<OBJECT> actual) {
* fieldUpdater.set(person, 28);
* assertThat(fieldUpdater).hasValue(25, person);</code></pre>
*
* @param expectedValue the expected value inside the {@link OBJECT}.
* @param expectedValue the expected value inside the {@code OBJECT}.
* @param obj the object holding the updatable field.
* @return this assertion object.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2196,8 +2196,8 @@ public AtomicReferenceArrayAssert<T> filteredOn(Condition<? super T> condition)
* @since 3.7.0
*/
@Override
public AtomicReferenceArrayAssert<T> allMatch(Predicate<? super T> condition) {
iterables.assertAllMatch(info, newArrayList(array), condition, PredicateDescription.GIVEN);
public AtomicReferenceArrayAssert<T> allMatch(Predicate<? super T> predicate) {
iterables.assertAllMatch(info, newArrayList(array), predicate, PredicateDescription.GIVEN);
return myself;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public AtomicReferenceFieldUpdaterAssert(AtomicReferenceFieldUpdater<OBJECT, FIE
* fieldUpdater.set(person, "Batman");
* assertThat(fieldUpdater).hasValue("Superman", person);</code></pre>
*
* @param expectedValue the expected value inside the {@link OBJECT}.
* @param expectedValue the expected value inside the {@code OBJECT}.
* @param obj the object holding the updatable field.
* @return this assertion object.
*/
Expand Down
1 change: 0 additions & 1 deletion src/main/java/org/assertj/core/api/LocalDateAssert.java
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ public class LocalDateAssert extends AbstractLocalDateAssert<LocalDateAssert> {
/**
* Creates a new <code>{@link LocalDateAssert}</code>.
*
* @param selfType the "self type"
* @param actual the actual value to verify
*/
protected LocalDateAssert(LocalDate actual) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ public class LocalDateTimeAssert extends AbstractLocalDateTimeAssert<LocalDateTi
/**
* Creates a new <code>{@link LocalDateTimeAssert}</code>.
*
* @param selfType the "self type"
* @param actual the actual value to verify
*/
protected LocalDateTimeAssert(LocalDateTime actual) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
/**
* Assertion class checking {@link Throwable} type.
* <p>
* The class itself does not do much, it delegates the work to {@link ThrowableAssertAlternative} after calling {@link #isThrownBy(ThrowingCallable)}.
* The class itself does not do much, it delegates the work to {@link ThrowableAssertAlternative} after calling {@link #isThrownBy(ThrowableAssert.ThrowingCallable)}.
*
* @param <T> type of throwable to be thrown.
*/
Expand Down
14 changes: 7 additions & 7 deletions src/main/java/org/assertj/core/api/WithAssertions.java
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ default <T> Condition<T> allOf(@SuppressWarnings("unchecked") final Condition<?
}

/**
* Delegate call to {@link org.assertj.core.api.Assertions#assertThat(T[])}
* Delegate call to {@link org.assertj.core.api.Assertions#assertThat(Object[])}
*/
@CheckReturnValue
default <T> AbstractObjectArrayAssert<?, T> assertThat(final T[] actual) {
Expand Down Expand Up @@ -194,7 +194,7 @@ default AbstractLongArrayAssert<?> assertThat(final long[] actual) {
}

/**
* Delegate call to {@link org.assertj.core.api.Assertions#assertThat(T)}
* Delegate call to {@link org.assertj.core.api.Assertions#assertThat(Object)}
*/
@CheckReturnValue
default <T> AbstractObjectAssert<?, T> assertThat(final T actual) {
Expand Down Expand Up @@ -896,15 +896,15 @@ default AbstractOffsetDateTimeAssert<?> assertThat(final OffsetDateTime offsetDa
}

/**
* Delegate call to {@link org.assertj.core.api.Assertions#assertThatThrownBy(ThrowingCallable)}
* Delegate call to {@link org.assertj.core.api.Assertions#assertThatThrownBy(ThrowableAssert.ThrowingCallable)}
*/
default AbstractThrowableAssert<?, ? extends Throwable> assertThatThrownBy(
final ThrowingCallable shouldRaiseThrowable) {
return Assertions.assertThatThrownBy(shouldRaiseThrowable);
}

/**
* Delegate call to {@link org.assertj.core.api.Assertions#catchThrowable(ThrowingCallable)}
* Delegate call to {@link org.assertj.core.api.Assertions#catchThrowable(ThrowableAssert.ThrowingCallable)}
*/
default Throwable catchThrowable(final ThrowingCallable shouldRaiseThrowable) {
return Assertions.catchThrowable(shouldRaiseThrowable);
Expand All @@ -918,8 +918,8 @@ default Throwable catchThrowable(final ThrowingCallable shouldRaiseThrowable) {
* <pre><code class='java'> assertThatExceptionOfType(IOException.class).isThrownBy(() -> { throw new IOException("boom!"); })
* .withMessage("boom!"); </code></pre>
*
* This method is more or less the same of {@link #assertThatThrownBy(ThrowingCallable)} but in a more natural way.
* @param actual the actual value.
* This method is more or less the same of {@link #assertThatThrownBy(ThrowableAssert.ThrowingCallable)} but in a more natural way.
* @param exceptionType the actual value.
* @return the created {@link ThrowableTypeAssert}.
*/
default <T extends Throwable> ThrowableTypeAssert<T> assertThatExceptionOfType(final Class<? extends T> exceptionType) {
Expand Down Expand Up @@ -980,7 +980,7 @@ default <T> T assertThat(final AssertProvider<T> component) {
// --------------------------------------------------------------------------------------------------

/**
* Delegate call to {@link org.assertj.core.api.Assertions#filter(E[])}
* Delegate call to {@link org.assertj.core.api.Assertions#filter(Object[])}
*/
default <E> Filters<E> filter(final E[] array) {
return Assertions.filter(array);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ public class ZonedDateTimeAssert extends AbstractZonedDateTimeAssert<ZonedDateTi
/**
* Creates a new <code>{@link ZonedDateTimeAssert}</code>.
*
* @param selfType the "self type"
* @param actual the actual value to verify
*/
protected ZonedDateTimeAssert(ZonedDateTime actual) {
Expand Down

0 comments on commit 3889a64

Please sign in to comment.