Skip to content

Commit d1588be

Browse files
Improve DownloadFilter documentation and fix indentation
1 parent 7d6a964 commit d1588be

File tree

1 file changed

+15
-15
lines changed
  • services-custom/s3-transfer-manager/src/main/java/software/amazon/awssdk/transfer/s3/config

1 file changed

+15
-15
lines changed

services-custom/s3-transfer-manager/src/main/java/software/amazon/awssdk/transfer/s3/config/DownloadFilter.java

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -39,23 +39,23 @@ public interface DownloadFilter extends Predicate<S3Object> {
3939
@Override
4040
boolean test(S3Object s3Object);
4141

42-
/*
43-
* Returns a composed filter that performs AND operation
44-
*
45-
* @param other the predicate to AND with this predicate
46-
* @return a composed predicate that performs OR operation
47-
* @throws NullPointerException if other is null
42+
/**
43+
* Returns a composed filter that performs AND operation
44+
* @param other a predicate that will be logically-ANDed with this
45+
* predicate
46+
* @return a composed predicate that performs AND operation
47+
* @throws NullPointerException if other is null
4848
*/
4949
@Override
5050
default DownloadFilter and(Predicate<? super S3Object> other) {
5151
Objects.requireNonNull(other, "Other predicate cannot be null");
5252
return s3Object -> test(s3Object) && other.test(s3Object);
5353
}
5454

55-
/*
56-
* Returns a composed filter that performs OR operation
57-
*
58-
* @param other the predicate to OR with this predicate
55+
/**
56+
* Returns a predicate that represents the logical OR of this predicate and another
57+
* @param other a predicate that will be logically-ORed with this
58+
* predicate
5959
* @return a composed predicate that performs OR operation
6060
* @throws NullPointerException if other is null
6161
*/
@@ -65,11 +65,11 @@ default DownloadFilter or(Predicate<? super S3Object> other) {
6565
return s3Object -> test(s3Object) || other.test(s3Object);
6666
}
6767

68-
/*
69-
* Returns a predicate that represents the logical negation of this predicate.
70-
* If this predicate would download an object, the negated predicate will not download it, and vice versa.
71-
*
72-
* @return a predicate that represents the logical negation of this predicate
68+
/**
69+
* Returns a predicate that represents the logical negation of this
70+
* predicate.
71+
* @return a predicate that represents the logical negation of this
72+
* predicate
7373
*/
7474
@Override
7575
default DownloadFilter negate() {

0 commit comments

Comments
 (0)