org.springframework.data.rest.webmvc.support

Class DefaultedPageable

java.lang.Object

org.springframework.data.rest.webmvc.support.DefaultedPageable

public final class DefaultedPageable
extends Object

Value object to capture a Pageable as well whether it is the default one configured.

Author:

Oliver Gierke

Constructor Summary

Constructors

Constructor and Description
DefaultedPageable(@NonNull Pageable pageable, boolean isDefault)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
@NonNull Pageable	getPageable() Returns the delegate Pageable.
int	hashCode()
boolean	isDefault() Returns whether the contained Pageable is the default one configured.
String	toString()
Pageable	unpagedIfDefault() Returns Pageable.unpaged() if the contained Pageable is the default one.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultedPageable

public DefaultedPageable(@NonNull
                         @NonNull Pageable pageable,
                         boolean isDefault)

Method Detail

isDefault

public boolean isDefault()

Returns whether the contained Pageable is the default one configured.

Returns:

the isDefault

unpagedIfDefault

public Pageable unpagedIfDefault()

Returns Pageable.unpaged() if the contained Pageable is the default one.

Returns:

will never be null.

Since:

3.3

getPageable

@NonNull
public @NonNull Pageable getPageable()

Returns the delegate Pageable.

Returns:

can be null.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object