com.github.crob1140.confluence.requests

Class CreateContentRequest.Builder

java.lang.Object

com.github.crob1140.confluence.requests.CreateContentRequest.Builder

Enclosing class:

CreateContentRequest

public static class CreateContentRequest.Builder
extends java.lang.Object

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CreateContentRequest.Builder	addLabel(java.lang.String label) This method adds a label to the content created by the request, with the global prefix.
CreateContentRequest.Builder	addLabel(java.lang.String label, LabelPrefix prefix) This method adds a label to the content created by the request with the given value and prefix.
CreateContentRequest	build() This method creates an instance of CreateContentRequest using the values that were set on this instance.
CreateContentRequest.Builder	setAncestor(java.lang.String id) This method sets the ancestor for the content by ID.
CreateContentRequest.Builder	setBody(ContentBodyType type, java.lang.String content) This method sets the body of the content.
CreateContentRequest.Builder	setExpandedResponseProperties(ExpandedContentProperties expandedResponseProperties) This method sets the properties to be expanded in the Content instance that is returned as a response to this request.
CreateContentRequest.Builder	setId(java.lang.String id) This method sets the unique identifier for the content.
CreateContentRequest.Builder	setResponseStatusFilter(ContentStatus status) This method sets the status filter for the Content that is returned as a response to the request.
CreateContentRequest.Builder	setSpaceKey(java.lang.String spaceKey) This method sets the space that this content shall belong to by key.
CreateContentRequest.Builder	setStatus(ContentStatus status) This method sets the status of the content.
CreateContentRequest.Builder	setTitle(java.lang.String title) This method sets the title of the content.
CreateContentRequest.Builder	setType(StandardContentType type) This method defines the type of the content.
CreateContentRequest.Builder	setType(java.lang.String type) This method defines the type of the content.

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

setAncestor

public CreateContentRequest.Builder setAncestor(java.lang.String id)

This method sets the ancestor for the content by ID.

Parameters:

id - The ID of the ancestor.

Returns:

This instance, for the purposes of method chaining.

setId

public CreateContentRequest.Builder setId(java.lang.String id)

This method sets the unique identifier for the content.

Parameters:

id - The unique identifier for the content.

Returns:

This instance, for the purposes of method chaining.

setTitle

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

This method sets the title of the content.

Parameters:

title - The title of the content.

Returns:

This instance, for the purposes of method chaining.

setSpaceKey

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

This method sets the space that this content shall belong to by key.

Parameters:

spaceKey - The key of the space that this content shall belong to.

Returns:

This instance, for the purposes of method chaining.

setStatus

public CreateContentRequest.Builder setStatus(ContentStatus status)

This method sets the status of the content.

Parameters:

status - The status of the content.

Returns:

This instance, for the purposes of method chaining.

setBody

public CreateContentRequest.Builder setBody(ContentBodyType type,
                                            java.lang.String content)

This method sets the body of the content.

Parameters:

type - The body type that is being defined.

content - The value to set for the body type.

Returns:

This intance, for the purposes of method chaining.

setType

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

This method defines the type of the content. This should be used when setting the content type to a custom type defined by an app. For setting standard content types, refer to setType(StandardContentType) instead.

Parameters:

type - The type of the content.

Returns:

This instance, for the purposes of method chaining.

setType

public CreateContentRequest.Builder setType(StandardContentType type)

This method defines the type of the content. This may match one of the values defined in StandardContentType, or may be a custom content type defined by an app.

Parameters:

type - The type of the content.

Returns:

This instance, for the purposes of method chaining.

setResponseStatusFilter

public CreateContentRequest.Builder setResponseStatusFilter(ContentStatus status)

This method sets the status filter for the Content that is returned as a response to the request.

Parameters:

status - The status filter for the returned content.

Returns:

This instance, for the purposes of method chaining.

addLabel

public CreateContentRequest.Builder addLabel(java.lang.String label)

This method adds a label to the content created by the request, with the global prefix. To specify a different prefix, refer to addLabel(String, LabelPrefix) instead.

Parameters:

label - The label to add to the content.

Returns:

This instance, for the purposes of method chaining.

addLabel

public CreateContentRequest.Builder addLabel(java.lang.String label,
                                             LabelPrefix prefix)

This method adds a label to the content created by the request with the given value and prefix.

Parameters:

label - The label to add to the content.

prefix - The prefix of the label.

Returns:

This instance, for the purposes of method chaining.

setExpandedResponseProperties

public CreateContentRequest.Builder setExpandedResponseProperties(ExpandedContentProperties expandedResponseProperties)

This method sets the properties to be expanded in the Content instance that is returned as a response to this request.

Parameters:

expandedResponseProperties - the properties to expand in the Content instance that is returned as a response to this request.

Returns:

This instance, for the purposes of method chaining.

build

public CreateContentRequest build()
                           throws java.lang.IllegalStateException

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

Returns:

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

Throws:

java.lang.IllegalStateException - If the request that would be created would be invalid.