Package com.adobe.cq.testing.client

Class ExperienceFragmentsClient.ExperienceFragmentBuilder

java.lang.Object

com.adobe.cq.testing.client.ExperienceFragmentsClient.ExperienceFragmentBuilder

Enclosing class:

ExperienceFragmentsClient

public class ExperienceFragmentsClient.ExperienceFragmentBuilder
extends Object

An Experience Fragment builder

Constructor Summary

Constructors

Constructor	Description
ExperienceFragmentBuilder(ExperienceFragmentsClient client, String xfTitle, String variantTitle, String variantTemplate)	Constructor

Method Summary

Modifier and Type	Method	Description
ExperienceFragmentsClient.ExperienceFragmentBuilder	addVariantTag(String variantTag)	Add a tag to the Experience Fragment Variant
ExperienceFragmentsClient.ExperienceFragmentBuilder	addVariantTags(List<String> variantTags)	Add tags to the Experience Fragment Variant
ExperienceFragmentsClient.ExperienceFragmentBuilder	addXFTag(String xfTag)	Add a tag to the Experience Fragment
ExperienceFragmentsClient.ExperienceFragmentBuilder	addXFTags(List<String> xfTags)	Add tags to the Experience Fragment
org.apache.sling.testing.clients.SlingHttpResponse	create(int... expectedStatus)	Create the Experience Fragment with the information configured in this builder object
ExperienceFragmentsClient.ExperienceFragmentBuilder	withParentPath(String parentPath)	Set the parent path
ExperienceFragmentsClient.ExperienceFragmentBuilder	withVariantName(String variantName)	Set the Experience Fragment Variant name
ExperienceFragmentsClient.ExperienceFragmentBuilder	withXFDescription(String description)	Set the Experience Fragment description
ExperienceFragmentsClient.ExperienceFragmentBuilder	withXFName(String xfName)	Set the Experience Fragment name

Methods inherited from class java.lang.Object

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

Constructor Detail

ExperienceFragmentBuilder

public ExperienceFragmentBuilder(ExperienceFragmentsClient client,
                                 String xfTitle,
                                 String variantTitle,
                                 String variantTemplate)

Constructor

Parameters:

client - the Experience Fragment client

xfTitle - the title for the Experience Fragment

variantTitle - the title for the Experience Fragment Variant

variantTemplate - the template for the Experience Fragment Variant

Method Detail

withParentPath

public ExperienceFragmentsClient.ExperienceFragmentBuilder withParentPath(String parentPath)

Set the parent path

Parameters:

parentPath - parent path

Returns:

this

withXFName

public ExperienceFragmentsClient.ExperienceFragmentBuilder withXFName(String xfName)

Set the Experience Fragment name

Parameters:

xfName - name

Returns:

this

withXFDescription

public ExperienceFragmentsClient.ExperienceFragmentBuilder withXFDescription(String description)

Set the Experience Fragment description

Parameters:

description - experience fragment description

Returns:

this

addXFTag

public ExperienceFragmentsClient.ExperienceFragmentBuilder addXFTag(String xfTag)

Add a tag to the Experience Fragment

Parameters:

xfTag - tag to be added

Returns:

this

addXFTags

public ExperienceFragmentsClient.ExperienceFragmentBuilder addXFTags(List<String> xfTags)

Add tags to the Experience Fragment

Parameters:

xfTags - list of tags to be added

Returns:

this

withVariantName

public ExperienceFragmentsClient.ExperienceFragmentBuilder withVariantName(String variantName)

Set the Experience Fragment Variant name

Parameters:

variantName - variant name

Returns:

this

addVariantTag

public ExperienceFragmentsClient.ExperienceFragmentBuilder addVariantTag(String variantTag)

Add a tag to the Experience Fragment Variant

Parameters:

variantTag - variant tag

Returns:

this

addVariantTags

public ExperienceFragmentsClient.ExperienceFragmentBuilder addVariantTags(List<String> variantTags)

Add tags to the Experience Fragment Variant

Parameters:

variantTags - list of variant tags

Returns:

this

create

public org.apache.sling.testing.clients.SlingHttpResponse create(int... expectedStatus)
                                                          throws org.apache.sling.testing.clients.ClientException

Create the Experience Fragment with the information configured in this builder object

Parameters:

expectedStatus - http status expected after sending the Experience Fragment create request

Returns:

The full SlingHttpResponse for the experience fragment create request

Throws:

org.apache.sling.testing.clients.ClientException - if the request fails