com.github.crob1140.confluence.requests

Class GetContentRequest.Builder

java.lang.Object

com.github.crob1140.confluence.requests.GetContentRequest.Builder

Enclosing class:

GetContentRequest

public static final class GetContentRequest.Builder
extends java.lang.Object

This class can be used to construct an instance of GetContentRequest.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
GetContentRequest	build() This method creates an instance of GetContentRequest using the values that were set on this instance.
GetContentRequest.Builder	orderBy(java.lang.String field, SortDirection direction) This method sets the order-by clause for the query.
GetContentRequest.Builder	setExpandedProperties(ExpandedContentProperties expandedProperties) This method sets the properties to be expanded in the results of this request.
GetContentRequest.Builder	setLimit(java.lang.Integer limit) This method sets the maximum number of results for the request.
GetContentRequest.Builder	setPostingDay(java.time.LocalDate postingDay) This method sets the required posting day for results.
GetContentRequest.Builder	setSpaceKey(java.lang.String spaceKey) This method sets the space key for results.
GetContentRequest.Builder	setStartPosition(java.lang.Integer start) This method sets the pagination start position for the request.
GetContentRequest.Builder	setStatus(ContentStatus status) This method sets the required status for results.
GetContentRequest.Builder	setTitle(java.lang.String title) This methods sets the required title for results.
GetContentRequest.Builder	setTrigger(java.lang.String trigger) This methods sets the event to trigger as a result of this request.
GetContentRequest.Builder	setType(StandardContentType type) This method sets the type of content to return.
GetContentRequest.Builder	setType(java.lang.String type) This method sets the type of content to return.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setLimit

public GetContentRequest.Builder setLimit(java.lang.Integer limit)

This method sets the maximum number of results for the request.

Parameters:

limit - the maximum number of results

Returns:

This instance, for the purposes of method chaining.

orderBy

public GetContentRequest.Builder orderBy(java.lang.String field,
                                         SortDirection direction)

This method sets the order-by clause for the query.

Parameters:

field - the name of the field to order the results by

direction - the direction in which the results should be sorted

Returns:

This instance, for the purposes of method chaining.

setPostingDay

public GetContentRequest.Builder setPostingDay(java.time.LocalDate postingDay)

This method sets the required posting day for results. Only content that was created on the given date will be returned as results.

Parameters:

postingDay - the posting date

Returns:

This instance, for the purposes of method chaining.

setSpaceKey

public GetContentRequest.Builder setSpaceKey(java.lang.String spaceKey)

This method sets the space key for results. Only content within the given space will be returned.

Parameters:

spaceKey - the key of the space

Returns:

This instance, for the purposes of method chaining.

setStartPosition

public GetContentRequest.Builder setStartPosition(java.lang.Integer start)

This method sets the pagination start position for the request.

Parameters:

start - the pagination start position

Returns:

This instance, for the purposes of method chaining.

setStatus

public GetContentRequest.Builder setStatus(ContentStatus status)

This method sets the required status for results. Only content with the given status will be returned as results.

Parameters:

status - the status of results

Returns:

This instance, for the purposes of method chaining.

setTitle

public GetContentRequest.Builder setTitle(java.lang.String title)

This methods sets the required title for results. Only content with the given title will be returned as results.

Parameters:

title - the title of results

Returns:

This instance, for the purposes of method chaining.

setTrigger

public GetContentRequest.Builder setTrigger(java.lang.String trigger)

This methods sets the event to trigger as a result of this request.

Parameters:

trigger - the trigger of results

Returns:

This instance, for the purposes of method chaining.

setType

public GetContentRequest.Builder setType(java.lang.String type)

This method sets the type of content to return. Only content with the given type will be returned as results.

Parameters:

type - the type of results

Returns:

This instance, for the purposes of method chaining.

setType

public GetContentRequest.Builder setType(StandardContentType type)

This method sets the type of content to return. Only content with the given type will be returned as results.

Parameters:

type - the type of results

Returns:

This instance, for the purposes of method chaining.

setExpandedProperties

public GetContentRequest.Builder setExpandedProperties(ExpandedContentProperties expandedProperties)

This method sets the properties to be expanded in the results of this request.

Parameters:

expandedProperties - the properties to expand in the results of this request.

Returns:

This instance, for the purposes of method chaining.

build

public GetContentRequest build()
                        throws java.lang.IllegalStateException

This method creates an instance of GetContentRequest using the values that were set on this instance.

Returns:

A new instance of GetContentRequest with the values set on this instance.

Throws:

java.lang.IllegalStateException