Polishing.

Refine documentation. Introduce isLimited method to mirror isPresent/isSorted semantics. Introduce Pageable.toLimit() method to deduplicate code.

See #2827
Original pull request: #2836
This commit is contained in:
Mark Paluch
2023-07-05 10:02:37 +02:00
parent a5408a478d
commit 15bb8aa482
8 changed files with 118 additions and 94 deletions

View File

@@ -28,25 +28,12 @@ import org.springframework.util.ClassUtils;
* over using {@literal null} or {@link java.util.Optional#empty()} to indicate the absence of an actual {@link Limit}.
* </p>
* {@link Limit} itself does not make assumptions about the actual {@link #max()} value sign. This means that a negative
* value may be valid within a defined context. Implementations should override {@link #isUnlimited()} to fit their
* needs and enforce restrictions if needed.
*
* value may be valid within a defined context.
*
* @author Christoph Strobl
* @since 3.2
*/
public sealed interface Limit permits Limited, Unlimited {
/**
* @return the max number of potential results.
*/
int max();
/**
* @return {@literal true} if no limiting (maximum value) should be applied.
*/
default boolean isUnlimited() {
return Unlimited.INSTANCE.equals(this);
}
public sealed interface Limit permits Limited,Unlimited {
/**
* @return a {@link Limit} instance that does not define {@link #max()} and answers {@link #isUnlimited()} with
@@ -66,6 +53,23 @@ public sealed interface Limit permits Limited, Unlimited {
return new Limited(max);
}
/**
* @return the max number of potential results.
*/
int max();
/**
* @return {@literal true} if limiting (maximum value) should be applied.
*/
boolean isLimited();
/**
* @return {@literal true} if no limiting (maximum value) should be applied.
*/
default boolean isUnlimited() {
return !isLimited();
}
final class Limited implements Limit {
private final int max;
@@ -79,6 +83,11 @@ public sealed interface Limit permits Limited, Unlimited {
return max;
}
@Override
public boolean isLimited() {
return true;
}
@Override
public boolean equals(Object obj) {
@@ -97,7 +106,7 @@ public sealed interface Limit permits Limited, Unlimited {
@Override
public int hashCode() {
return (int) (max ^ (max >>> 32));
return max ^ (max >>> 32);
}
}
@@ -110,12 +119,13 @@ public sealed interface Limit permits Limited, Unlimited {
@Override
public int max() {
throw new IllegalStateException(
"Unlimited does not define 'max'. Please check 'isUnlimited' before attempting to read 'max'");
"Unlimited does not define 'max'. Please check 'isLimited' before attempting to read 'max'");
}
@Override
public boolean isUnlimited() {
return true;
public boolean isLimited() {
return false;
}
}
}

View File

@@ -173,6 +173,22 @@ public interface Pageable {
return isUnpaged() ? Optional.empty() : Optional.of(this);
}
/**
* Returns an {@link Limit} from this pageable if the page request {@link #isPaged() is paged} or
* {@link Limit#unlimited()} otherwise.
*
* @return
* @since 3.2
*/
default Limit toLimit() {
if (isUnpaged()) {
return Limit.unlimited();
}
return Limit.of(getPageSize());
}
/**
* Returns an {@link OffsetScrollPosition} from this pageable if the page request {@link #isPaged() is paged}.
*