com.htmlhifive.pitalium.core.model

クラス ScreenshotArgument

java.lang.Object

com.htmlhifive.pitalium.core.model.ScreenshotArgument

public class ScreenshotArgument
extends java.lang.Object

スクリーンショットを撮影するための要素を指定するセレクタや座標、除外する要素の情報等を持つクラス

builder()またはbuilder(String)でビルダーを取得してスクリーンショットの撮影方法を組み立てます。

作成者:

nakatani

コンストラクタのサマリー

コンストラクタ

修飾子	コンストラクタと説明
protected	ScreenshotArgument(java.lang.String screenshotId, java.util.List<CompareTarget> targets, java.util.List<DomSelector> hiddenElementSelectors) 初期化します。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
static ScreenshotArgumentBuilder	builder() ScreenshotArgumentを構築するためのビルダーオブジェクトをスクリーンショットIDを指定せずに取得します。
static ScreenshotArgumentBuilder	builder(java.lang.String newScreenshotId) ScreenshotArgumentを構築するためのビルダーオブジェクトをスクリーンショットIDを指定して取得します。
boolean	equals(java.lang.Object o)
java.util.List<DomSelector>	getHiddenElementSelectors() スクリーンショット撮影時に非表示にする要素を示すセレクタのリストを取得します。
java.lang.String	getScreenshotId() スクリーンショットIDを取得します。
java.util.List<CompareTarget>	getTargets() スクリーンショット取得・比較の対象となる領域のリストを取得します。
int	hashCode()
java.lang.String	toString()
ScreenshotArgument	withScreenshotId(java.lang.String newScreenshotId) targets、hiddenElementSelectors のコレクションの中身を変更せず、スクリーンショットIDだけをscreenshotIdで指定した値に変更した新しいScreenshotArgumentを返します。

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

ScreenshotArgument

protected ScreenshotArgument(java.lang.String screenshotId,
                             java.util.List<CompareTarget> targets,
                             java.util.List<DomSelector> hiddenElementSelectors)

初期化します。

パラメータ:

screenshotId - スクリーンショットID

targets - スクリーンショット取得・比較の対象となる領域のリスト

hiddenElementSelectors - スクリーンショット撮影時に非表示にする要素を示すセレクタのリスト

例外:

java.lang.NullPointerException - screenshotIdがnullまたは空文字だった場合

メソッドの詳細

builder

public static ScreenshotArgumentBuilder builder()

ScreenshotArgumentを構築するためのビルダーオブジェクトをスクリーンショットIDを指定せずに取得します。

戻り値:

ビルダーオブジェクト

builder

public static ScreenshotArgumentBuilder builder(java.lang.String newScreenshotId)

ScreenshotArgumentを構築するためのビルダーオブジェクトをスクリーンショットIDを指定して取得します。

パラメータ:

newScreenshotId - スクリーンショットID

戻り値:

ビルダーオブジェクト

getScreenshotId

public java.lang.String getScreenshotId()

スクリーンショットIDを取得します。

戻り値:

スクリーンショットID

getTargets

public java.util.List<CompareTarget> getTargets()

スクリーンショット取得・比較の対象となる領域のリストを取得します。

戻り値:

スクリーンショット取得・比較の対象となる領域のリスト

getHiddenElementSelectors

public java.util.List<DomSelector> getHiddenElementSelectors()

スクリーンショット撮影時に非表示にする要素を示すセレクタのリストを取得します。

戻り値:

スクリーンショット撮影時に非表示にする要素を示すセレクタのリスト

withScreenshotId

public ScreenshotArgument withScreenshotId(java.lang.String newScreenshotId)

targets、hiddenElementSelectors のコレクションの中身を変更せず、スクリーンショットIDだけをscreenshotIdで指定した値に変更した新しいScreenshotArgumentを返します。

パラメータ:

newScreenshotId - 新しいスクリーンショットID

戻り値:

スクリーンショットIDが変更された新しいオブジェクト

equals

public boolean equals(java.lang.Object o)

オーバーライド:

equals クラス内 java.lang.Object

hashCode

public int hashCode()

オーバーライド:

hashCode クラス内 java.lang.Object

toString

public java.lang.String toString()

オーバーライド:

toString クラス内 java.lang.Object