com.github.crob1140.confluence.requests

Class UpdateContentRequest.Builder

java.lang.Object

com.github.crob1140.confluence.requests.UpdateContentRequest.Builder

Enclosing class:

UpdateContentRequest

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

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
UpdateContentRequest.Builder	addLabel(java.lang.String label) This method adds a label to the content updated by the request, with the global prefix.
UpdateContentRequest.Builder	addLabel(java.lang.String label, LabelPrefix prefix) This method adds a label to the content updated by the request with the given value and prefix.
UpdateContentRequest	build() This method creates an instance of UpdateContentRequest using the values that were set on this instance.
UpdateContentRequest.Builder	setAncestor(java.lang.String id) This method sets the ancestor for the content by ID.
UpdateContentRequest.Builder	setBody(ContentBodyType type, java.lang.String content) This method sets the body of the content.
UpdateContentRequest.Builder	setId(java.lang.String id) This method sets the unique identifier of the content to be updated.
UpdateContentRequest.Builder	setStatus(ContentStatus status) This method sets the status of the content.
UpdateContentRequest.Builder	setTitle(java.lang.String title) This method sets the title of the content.
UpdateContentRequest.Builder	setType(StandardContentType type) This method defines the type of the content.
UpdateContentRequest.Builder	setType(java.lang.String type) This method defines the type of the content.
UpdateContentRequest.Builder	setVersion(int versionNumber) This method sets the version number 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

setId

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

This method sets the unique identifier of the content to be updated.

Parameters:

id - The unique identifier for the content.

Returns:

This instance, for the purposes of method chaining.

setAncestor

public UpdateContentRequest.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.

setVersion

public UpdateContentRequest.Builder setVersion(int versionNumber)

This method sets the version number of the content.

Parameters:

versionNumber - The version number of the content.

Returns:

This instance, for the purposes of method chaining.

setStatus

public UpdateContentRequest.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.

addLabel

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

This method adds a label to the content updated 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 UpdateContentRequest.Builder addLabel(java.lang.String label,
                                             LabelPrefix prefix)

This method adds a label to the content updated 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.

setBody

public UpdateContentRequest.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 instance, for the purposes of method chaining.

setType

public UpdateContentRequest.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 UpdateContentRequest.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.

setTitle

public UpdateContentRequest.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.

build

public UpdateContentRequest build()

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

Returns:

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

Throws:

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