QueryBounds (Atlassian Marketplace Client 2.0.0-m4 API)

java.lang.Object
- com.atlassian.marketplace.client.api.QueryBounds

```
public class QueryBounds
extends Object
```
Holds the pagination parameters offset and limit, which are supported by many queries.

Since:

2.0.0

Method Summary

Methods
Modifier and Type	Method and Description
`static QueryBounds`	`defaultBounds()` Returns a `QueryBounds` instance with no `offset` or `limit` specified.
`Iterable<String>`	`describe()`
`static QueryBounds`	`empty()` Returns a `QueryBounds` instance with `limit` set to `some(0)`, so that the result set will always be empty.
`boolean`	`equals(Object other)`
`com.atlassian.fugue.Option<Integer>`	`getLimit()` The maximum number of items that the client wants to receive in the result set.
`int`	`getOffset()` The number of items that the client wants to skip past at the start of the result set.
`int`	`hashCode()`
`static QueryBounds`	`limit(com.atlassian.fugue.Option<Integer> limit)` Constructs a new `QueryBounds` instance that optionally specifies the maximum number of items to be included in each page of the result set.
`static QueryBounds`	`offset(int offset)` Constructs a new `QueryBounds` instance that specifies some number of items to skip past at the start of the result set.
`QueryBounds`	`withLimit(com.atlassian.fugue.Option<Integer> limit)` Returns a copy of this QueryBounds instance with the `limit` property changed.
`QueryBounds`	`withOffset(int offset)` Returns a copy of this QueryBounds instance with the `offset` property changed.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - offset
```
public static QueryBounds offset(int offset)
```
    Constructs a new QueryBounds instance that specifies some number of items to skip past at the start of the result set.
    
    Parameters:
    offset - the number of items to skip
    
    Returns:
    a QueryBounds instance
  - limit
```
public static QueryBounds limit(com.atlassian.fugue.Option<Integer> limit)
```
    Constructs a new QueryBounds instance that optionally specifies the maximum number of items to be included in each page of the result set. Note that the server may choose to impose a smaller maximum limit.
    
    Parameters:
    limit - the maximum number of items per result page, or Option.none() to leave this unspecified
    
    Returns:
    a QueryBounds instance
  - defaultBounds
```
public static QueryBounds defaultBounds()
```
    Returns a QueryBounds instance with no offset or limit specified.
  - empty
```
public static QueryBounds empty()
```
    Returns a QueryBounds instance with limit set to some(0), so that the result set will always be empty. This is useful if you want to query a collection resource simply to find out the total number of items it contains, or to look at its links, without actually accessing the items.
  - getOffset
```
public int getOffset()
```
    The number of items that the client wants to skip past at the start of the result set.
  - getLimit
```
public com.atlassian.fugue.Option<Integer> getLimit()
```
    The maximum number of items that the client wants to receive in the result set.
  - withOffset
```
public QueryBounds withOffset(int offset)
```
    Returns a copy of this QueryBounds instance with the offset property changed.
    
    See Also:
    offset
  - withLimit
```
public QueryBounds withLimit(com.atlassian.fugue.Option<Integer> limit)
```
    Returns a copy of this QueryBounds instance with the limit property changed.
    
    See Also:
    limit
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - describe
```
public Iterable<String> describe()
```

Class QueryBounds

Method Summary

Methods inherited from class java.lang.Object

Method Detail

offset

limit

defaultBounds

empty

getOffset

getLimit

withOffset

withLimit

equals

hashCode

describe