com.github.crob1140.confluence.content.expand

Class ExpandedContentProperties.Builder

java.lang.Object

com.github.crob1140.confluence.content.expand.ExpandedContentProperties.Builder

Enclosing class:

ExpandedContentProperties

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

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ExpandedContentProperties.Builder	addAncestors() This method adds "ancestors" as a property to be expanded.
ExpandedContentProperties.Builder	addBody(ContentBodyType type, ExpandedBodyFormatProperties properties) This method adds the given properties of the given body type to the list of expanded properties.
ExpandedContentProperties.Builder	addChildren(ExpandedChildrenProperties properties) This method adds the given children to the list of expanded properties.
ExpandedContentProperties.Builder	addChildTypes(ExpandedChildTypeProperties childTypes) This method adds the given child types to the list of expanded properties.
ExpandedContentProperties.Builder	addContainer() This method adds "container" as a property to be expanded.
ExpandedContentProperties.Builder	addDescendants(ExpandedDescendantsProperties properties) This method adds the given descedants to the list of expanded properties.
ExpandedContentProperties.Builder	addHistory(ExpandedHistoryProperties properties) This method adds the given history to the list of expanded properties.
ExpandedContentProperties.Builder	addMetadata(ExpandedMetadataProperties properties) This method adds the given metadata to the list of expanded properties.
ExpandedContentProperties.Builder	addOperations() This method adds "operations" as a property to be expanded.
ExpandedContentProperties.Builder	addRestrictions(ExpandedRestrictionProperties properties) This method adds the given restrictions to the list of expanded properties.
ExpandedContentProperties.Builder	addSpace() This method adds "space" as a property to be expanded.
ExpandedContentProperties.Builder	addVersion() This method adds "version" as a property to be expanded.
ExpandedContentProperties	build() This method creates an instance of ExpandedContentProperties using the values that were set on this instance.

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

addChildTypes

public ExpandedContentProperties.Builder addChildTypes(ExpandedChildTypeProperties childTypes)

This method adds the given child types to the list of expanded properties.

Parameters:

childTypes - The child types of the content that should be expanded.

Returns:

This instance, for the purposes of method chaining.

addContainer

public ExpandedContentProperties.Builder addContainer()

This method adds "container" as a property to be expanded.

Returns:

This instance, for the purposes of method chaining.

addMetadata

public ExpandedContentProperties.Builder addMetadata(ExpandedMetadataProperties properties)

This method adds the given metadata to the list of expanded properties.

Parameters:

properties - The properties of the content metadata that should be expanded.

Returns:

This instance, for the purposes of method chaining.

addOperations

public ExpandedContentProperties.Builder addOperations()

This method adds "operations" as a property to be expanded.

Returns:

This instance, for the purposes of method chaining.

addChildren

public ExpandedContentProperties.Builder addChildren(ExpandedChildrenProperties properties)

This method adds the given children to the list of expanded properties.

Parameters:

properties - The children of the content children that should be expanded.

Returns:

This instance, for the purposes of method chaining.

addRestrictions

public ExpandedContentProperties.Builder addRestrictions(ExpandedRestrictionProperties properties)

This method adds the given restrictions to the list of expanded properties.

Parameters:

properties - The restrictions on the content that should be expanded.

Returns:

This instance, for the purposes of method chaining.

addHistory

public ExpandedContentProperties.Builder addHistory(ExpandedHistoryProperties properties)

This method adds the given history to the list of expanded properties.

Parameters:

properties - The history properties that should be expanded.

Returns:

This instance, for the purposes of method chaining.

addAncestors

public ExpandedContentProperties.Builder addAncestors()

This method adds "ancestors" as a property to be expanded.

Returns:

This instance, for the purposes of method chaining.

addBody

public ExpandedContentProperties.Builder addBody(ContentBodyType type,
                                                 ExpandedBodyFormatProperties properties)

This method adds the given properties of the given body type to the list of expanded properties.

Parameters:

type - The type of content.

properties - The properties to expand for this type.

Returns:

This instance, for the purposes of method chaining.

addVersion

public ExpandedContentProperties.Builder addVersion()

This method adds "version" as a property to be expanded.

Returns:

This instance, for the purposes of method chaining.

addDescendants

public ExpandedContentProperties.Builder addDescendants(ExpandedDescendantsProperties properties)

This method adds the given descedants to the list of expanded properties.

Parameters:

properties - The descendants of the content that should be expanded.

Returns:

This instance, for the purposes of method chaining.

addSpace

public ExpandedContentProperties.Builder addSpace()

This method adds "space" as a property to be expanded.

Returns:

This instance, for the purposes of method chaining.

build

public ExpandedContentProperties build()

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

Returns:

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