Class PageCollection
- java.lang.Object
-
- com.trivago.cluecumber.engine.rendering.pages.pojos.pagecollections.PageCollection
-
- All Implemented Interfaces:
Cloneable
- Direct Known Subclasses:
AllFeaturesPageCollection,AllScenariosPageCollection,ScenarioDetailsPageCollection,ScenarioSummaryPageCollection,TreeViewPageCollection
public class PageCollection extends Object implements Cloneable
The base page collection.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PageCollectionclone()Clone this page collection for later filtering.List<CustomParameter>getCustomParameters()Get the custom parameters.Settings.CustomParamDisplayModegetDisplayMode()Get the display mode for custom parameters.List<Link>getNavigationLinks()Get custom navigation links.StringgetPageTitle()Get the page title.ReportDetailsgetReportDetails()Get the report details.booleanhasCustomParameters()Check if there are custom parameters.booleanisExpandAttachments()Check if attachments should be expanded.booleanisExpandBeforeAfterHooks()Check if before and after hooks should be expanded.booleanisExpandDocStrings()Check if doc strings should be expanded.booleanisExpandOutputs()Check if step outputs should be expanded.booleanisExpandPreviousScenarioRuns()This determines whether the not last run elements should be expanded and shown.booleanisExpandStepHooks()Check if step hooks should be expanded.booleanisExpandSubSections()Check if sub sections should be expanded.booleanisGroupPreviousScenarioRuns()This determines whether the scenarios run multiple times should be grouped and the show not last run toggle should be shown.voidsetCustomParameters(List<CustomParameter> customParameters)Set custom parameters.voidsetDisplayMode(Settings.CustomParamDisplayMode displayMode)Set the display mode for custom parameters.voidsetExpandAttachments(boolean expandAttachments)Set if attachments should be expanded.voidsetExpandBeforeAfterHooks(boolean expandBeforeAfterHooks)Set if before and after hooks should be expanded.voidsetExpandDocStrings(boolean expandDocStrings)Sheck if doc strings should be expanded.voidsetExpandOutputs(boolean expandOutputs)Set if step outputs should be expanded.voidsetExpandPreviousScenarioRuns(boolean expandPreviousScenarioRuns)Set whether the not last run elements should be expanded and shown.voidsetExpandStepHooks(boolean expandStepHooks)Set if step hooks should be expanded.voidsetExpandSubSections(boolean expandSubSections)Set if sub sections should be expanded.voidsetGroupPreviousScenarioRuns(boolean groupPreviousScenarioRuns)Set whether the scenarios run multiple times should be grouped and the show not last run toggle should be shown.voidsetNavigationLinks(List<Link> links)Set custom navigation links.
-
-
-
Method Detail
-
getReportDetails
public ReportDetails getReportDetails()
Get the report details.- Returns:
- The
ReportDetailsinstance.
-
isExpandBeforeAfterHooks
public boolean isExpandBeforeAfterHooks()
Check if before and after hooks should be expanded.- Returns:
- true if they should be expanded.
-
setExpandBeforeAfterHooks
public void setExpandBeforeAfterHooks(boolean expandBeforeAfterHooks)
Set if before and after hooks should be expanded.- Parameters:
expandBeforeAfterHooks- true if they should be expanded.
-
isExpandStepHooks
public boolean isExpandStepHooks()
Check if step hooks should be expanded.- Returns:
- true if they should be expanded.
-
setExpandStepHooks
public void setExpandStepHooks(boolean expandStepHooks)
Set if step hooks should be expanded.- Parameters:
expandStepHooks- true if they should be expanded.
-
isExpandDocStrings
public boolean isExpandDocStrings()
Check if doc strings should be expanded.- Returns:
- true if they should be expanded.
-
setExpandDocStrings
public void setExpandDocStrings(boolean expandDocStrings)
Sheck if doc strings should be expanded.- Parameters:
expandDocStrings- true if they should be expanded.
-
isExpandAttachments
public boolean isExpandAttachments()
Check if attachments should be expanded.- Returns:
- true if they should be expanded.
-
isExpandOutputs
public boolean isExpandOutputs()
Check if step outputs should be expanded.- Returns:
- true if they should be expanded.
-
setExpandAttachments
public void setExpandAttachments(boolean expandAttachments)
Set if attachments should be expanded.- Parameters:
expandAttachments- true if they should be expanded.
-
setExpandOutputs
public void setExpandOutputs(boolean expandOutputs)
Set if step outputs should be expanded.- Parameters:
expandOutputs- true if they should be expanded.
-
setExpandSubSections
public void setExpandSubSections(boolean expandSubSections)
Set if sub sections should be expanded.- Parameters:
expandSubSections- true if they should be expanded.
-
isExpandSubSections
public boolean isExpandSubSections()
Check if sub sections should be expanded.- Returns:
- true if they should be expanded.
-
isGroupPreviousScenarioRuns
public boolean isGroupPreviousScenarioRuns()
This determines whether the scenarios run multiple times should be grouped and the show not last run toggle should be shown.- Returns:
- true means scenarios should be grouped and toggle should be shown.
-
setGroupPreviousScenarioRuns
public void setGroupPreviousScenarioRuns(boolean groupPreviousScenarioRuns)
Set whether the scenarios run multiple times should be grouped and the show not last run toggle should be shown.- Parameters:
groupPreviousScenarioRuns- true means scenarios should be grouped and toggle should be shown.
-
isExpandPreviousScenarioRuns
public boolean isExpandPreviousScenarioRuns()
This determines whether the not last run elements should be expanded and shown.- Returns:
- true means it should be expanded.
-
setExpandPreviousScenarioRuns
public void setExpandPreviousScenarioRuns(boolean expandPreviousScenarioRuns)
Set whether the not last run elements should be expanded and shown.- Parameters:
expandPreviousScenarioRuns- true means elements should be expanded.
-
getPageTitle
public String getPageTitle()
Get the page title.- Returns:
- The page title.
-
getCustomParameters
public List<CustomParameter> getCustomParameters()
Get the custom parameters.- Returns:
- The
CustomParameterlist.
-
setCustomParameters
public void setCustomParameters(List<CustomParameter> customParameters)
Set custom parameters.- Parameters:
customParameters- TheCustomParameterlist.
-
hasCustomParameters
public boolean hasCustomParameters()
Check if there are custom parameters.- Returns:
- true if there are custom parameters.
-
getDisplayMode
public Settings.CustomParamDisplayMode getDisplayMode()
Get the display mode for custom parameters.- Returns:
- The
Settings.CustomParamDisplayModeenum.
-
setDisplayMode
public void setDisplayMode(Settings.CustomParamDisplayMode displayMode)
Set the display mode for custom parameters.- Parameters:
displayMode- TheSettings.CustomParamDisplayModeenum.
-
getNavigationLinks
public List<Link> getNavigationLinks()
Get custom navigation links.- Returns:
- The
Linklist.
-
setNavigationLinks
public void setNavigationLinks(List<Link> links)
Set custom navigation links.- Parameters:
links- TheLinklist.
-
clone
public PageCollection clone() throws CloneNotSupportedException
Clone this page collection for later filtering.- Overrides:
clonein classObject- Returns:
- The cloned collection.
- Throws:
CloneNotSupportedException- Thrown if cloning failed.
-
-