org.arquillian.extension.recorder

Class DefaultFileNameBuilder

java.lang.Object

org.arquillian.extension.recorder.AbstractFileNameBuilder

org.arquillian.extension.recorder.DefaultFileNameBuilder

Direct Known Subclasses:

ContainerAwareFileNameBuilder

public class DefaultFileNameBuilder
extends AbstractFileNameBuilder

Builds a file name of some screenshot resource.

Author:

Stefan Miklosovic

Field Summary

Fields

Modifier and Type	Field and Description
protected ResourceMetaData	metaData
protected ResourceIdentifier<ResourceType>	resourceIdentifier
protected When	when

Constructor Summary

Constructors

Constructor and Description
DefaultFileNameBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
String	build() When generation of file name is not overridden by withResourceIdentifier(ResourceIdentifier), by default, every file name will be of format: testMethodName_stage.screenshotType where stage is When.
DefaultFileNameBuilder	clear() Clears a builder.
DefaultFileNameBuilder	withMetaData(ResourceMetaData metaData)
DefaultFileNameBuilder	withResourceIdentifier(ResourceIdentifier<ResourceType> resourceIdentifier)
DefaultFileNameBuilder	withStage(When when)

Methods inherited from class java.lang.Object

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

Field Detail

metaData

protected ResourceMetaData metaData

when

protected When when

resourceIdentifier

protected ResourceIdentifier<ResourceType> resourceIdentifier

Constructor Detail

DefaultFileNameBuilder

public DefaultFileNameBuilder()

Method Detail

withMetaData

public DefaultFileNameBuilder withMetaData(ResourceMetaData metaData)

withStage

public DefaultFileNameBuilder withStage(When when)

withResourceIdentifier

public DefaultFileNameBuilder withResourceIdentifier(ResourceIdentifier<ResourceType> resourceIdentifier)

build

public String build()

When generation of file name is not overridden by withResourceIdentifier(ResourceIdentifier), by default, every file name will be of format:

testMethodName_stage.screenshotType

where stage is When. When you do not set meta data or name of test method is null or empty string, random UUID is generated instead of that. If When is not set, it is not included into file name generation. When you do not specify resource type, file name will be generated without file format suffix, excluding a dot as well.
After you get identifier, builder is cleared so every subsequent call of this method will return just UUID when there are not used 'when' methods.

Specified by:

build in class AbstractFileNameBuilder

Returns:

built file name

clear

public DefaultFileNameBuilder clear()

Description copied from class: AbstractFileNameBuilder

Clears a builder.

Specified by:

clear in class AbstractFileNameBuilder

Returns:

this