Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.action.util

Class PageParams

java.lang.Object

org.elasticsearch.xpack.core.action.util.PageParams

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class PageParams
extends Object
implements ToXContentObject, Writeable

Helper class collecting options for pagination in a search

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_FROM
static final int	DEFAULT_SIZE
static final ParseField	FROM
static final ParseField	PAGE
static final ConstructingObjectParser<PageParams,Void>	PARSER
static final ParseField	SIZE

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
PageParams()
PageParams(int from, int size)
PageParams(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static PageParams	defaultParams()
boolean	equals(Object obj)
static PageParams	fromXContent(XContentParser contentParser)
int	getFrom()
int	getSize()
int	hashCode()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

PAGE

public static final ParseField PAGE

FROM

public static final ParseField FROM

SIZE

public static final ParseField SIZE

DEFAULT_FROM

public static final int DEFAULT_FROM

See Also:

• Constant Field Values

DEFAULT_SIZE

public static final int DEFAULT_SIZE

See Also:

• Constant Field Values

PARSER

public static final ConstructingObjectParser<PageParams,Void> PARSER

Constructor Details

PageParams

public PageParams(StreamInput in)
           throws IOException

Throws:

IOException

PageParams

public PageParams()

PageParams

public PageParams(int from,
 int size)

Method Details

defaultParams

public static PageParams defaultParams()

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getFrom

public int getFrom()

getSize

public int getSize()

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

fromXContent

public static PageParams fromXContent(XContentParser contentParser)