Package com.applitools.eyes

Class BatchInfo

java.lang.Object

com.applitools.eyes.BatchInfo

public class BatchInfo
extends Object

Constructor Summary

Constructors

Constructor	Description
BatchInfo()
BatchInfo(String name)	See BatchInfo(String, Calendar).
BatchInfo(String id, String batchSequenceName, String name, String startedAt)
BatchInfo(String name, Calendar startedAt)	Creates a new BatchInfo instance.

Method Summary

Modifier and Type	Method	Description
BatchInfo	addProperty(String name, String value)
boolean	equals(Object obj)
String	getId()
String	getName()
List<Map<String,String>>	getProperties()
String	getSequenceName()
Calendar	getStartedAt()
boolean	isCompleted()
boolean	isNotifyOnCompletion()
void	setCompleted(boolean completed)
void	setId(String id)	Sets a unique identifier for the batch.
void	setNotifyOnCompletion(boolean notifyOnCompletion)
void	setSequenceName(String sequenceName)
void	setStartedAt(String startedAt)
String	toString()
BatchInfo	withBatchId(String id)	Sets a unique identifier for the batch and allows chaining of the id with the instance then returns that instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchInfo

public BatchInfo(String name,
                 Calendar startedAt)

Creates a new BatchInfo instance.

Parameters:

name - Name of batch or null if anonymous.

startedAt - Batch start time

BatchInfo

public BatchInfo(String id,
                 String batchSequenceName,
                 String name,
                 String startedAt)

BatchInfo

public BatchInfo()

BatchInfo

public BatchInfo(String name)

See BatchInfo(String, Calendar). startedAt defaults to the current time.

Parameters:

name - The name of the batch.

Method Detail

getName

public String getName()

Returns:

The name of the batch or null if anonymous.

getId

public String getId()

Returns:

The id of the current batch.

setId

public void setId(String id)

Sets a unique identifier for the batch. Sessions with batch info which includes the same ID will be grouped together.

Parameters:

id - The batch's ID

withBatchId

public BatchInfo withBatchId(String id)

Sets a unique identifier for the batch and allows chaining of the id with the instance then returns that instance. Sessions with batch info which includes the same ID will be grouped together.

Parameters:

id - The batch's ID

Returns:

The updated BatchInfo instance.

getStartedAt

public Calendar getStartedAt()

Returns:

The batch start date and time in ISO 8601 format.

setStartedAt

public void setStartedAt(String startedAt)

toString

public String toString()

Overrides:

toString in class Object

getSequenceName

public String getSequenceName()

setSequenceName

public void setSequenceName(String sequenceName)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

isNotifyOnCompletion

public boolean isNotifyOnCompletion()

setNotifyOnCompletion

public void setNotifyOnCompletion(boolean notifyOnCompletion)

isCompleted

public boolean isCompleted()

setCompleted

public void setCompleted(boolean completed)

addProperty

public BatchInfo addProperty(String name,
                             String value)

getProperties

public List<Map<String,String>> getProperties()