hamcrest APIリファレンス

hamcrestパッケージによって提供されるタイプのリファレンス。

IsAccessibleとIsAuditedForAccessibilityクラスが主要な機能を提供します。

com.deque.html.axedevtools.matchers.AxeDevtoolsMatcherはTypeSafeMatcher<AxeDriver>を拡張します

基本AxeDevToolsMatcherクラス。IsAccessibleやIsAuditedForAccessibilityなどの子クラスの方が一般的に使用されます。

AxeDevtoolsMatcher within(final String... cssSelectors)

アクセシビリティテスト中にチェックされるコンテキストにCSSセレクタを追加します。

cssSelectors: コンテキストを表すCSSセレクタ。

メソッドチェーン用としてAxeDevtoolsMatcherを返します。

AxeDevtoolsMatcher within(final Selector... selectors)

アクセシビリティテスト中にチェックされるコンテキストにセレクタを追加します。

selectors: コンテキストを表すセレクタ。

メソッドチェーン用としてAxeDevtoolsMatcherを返します。

AxeDevtoolsMatcher excluding(final String... cssSelectors)

アクセシビリティテスト中にチェックされるコンテキストからCSSセレクタを除外します。

cssSelectors: コンテキストを表すCSSセレクタ。

メソッドチェーン用としてAxeDevtoolsMatcherを返します。

AxeDevtoolsMatcher excluding(final Selector... selectors)

アクセシビリティテスト中にチェックされるコンテキストからセレクタを除外します。

selectors: コンテキストを表すセレクタ。

メソッドチェーン用としてAxeDevtoolsMatcherを返します。

AxeDevtoolsMatcher accordingTo(final String... tags)

アクセシビリティタグによって。指定されたアクセシビリティタグのみをチェックします。このオプションはcheckingOnlyと互換性がありません。 ルールの説明を参照してください。

tags: チェック用のタグのリスト。

メソッドチェーン用としてAxeDevtoolsMatcherを返します。

AxeDevtoolsMatcher checkingOnly(final String... rules)

アクセシビリティルールのみをチェックします。このオプションはaccordingToと互換性がありません。 ルールの説明を参照してください。

rules: チェック用のルールのリスト。

メソッドチェーン用としてAxeDevtoolsMatcherを返します。

AxeDevtoolsMatcher checking(final String... rules)

アクセシビリティルールをチェックします。指定されたタグに加えて、特定のルールもチェックします。 ルールの説明を参照してください。

rules: チェック用のルールのリスト。

メソッドチェーン用としてAxeDevtoolsMatcherを返します。

AxeDevtoolsMatcher skipping(final String... rules)

アクセシビリティルールをスキップします。指定されたタグ内から、特定のルールのチェックをスキップします。 ルールの説明を参照してください。

rules: チェック用のルールのリスト。

メソッドチェーン用としてAxeDevtoolsMatcherを返します。

AxeDevtoolsMatcher ignoring(final String selector, final String ruleId)

セレクタと指定されたルールIDに対する違反を無視します。

selector: axeアクセシビリティチェックで生成されたセレクタ。

ruleId: 指定されたセレクタに対して無視するルールID。

メソッドチェーン用としてAxeDevtoolsMatcherを返します。

AxeDevtoolsMatcher forConfig(final URL auditPath)

URLによって監査スイートを提供します。

auditPath: 監査スイートに関連付けられたURL。

メソッドチェーンのためにAxeDevtoolsMatcherを返します。

AxeDevtoolsMatcher forConfig(final String auditPath) はMalformedURLExceptionをスローします

ファイルシステム上の場所から監査スイートを提供します。

auditPath: 監査スイートの絶対ファイルパス。 メソッドチェーンのためにAxeDevtoolsMatcherを返します。 監査パスが無効なファイルシステムパスの場合、MalformedURLExceptionをスローします。

AxeDevtoolsMatcher logResults(final AxeReportingOptions reportingOptions)

アクセシビリティチェック完了時に結果を記録します。

reportingOptions: アクセシビリティチェックのシリアル化および永続化を定義するオプション。

メソッドチェーンのためにAxeDevtoolsMatcherを返します。

AxeDevtoolsMatcher forRuleset(final String rulesetId)

アクセシビリティチェックのためのルールセットを指定します。監査スイートを設定すると、指定されたルールセットが変更されます。 ルールセットを参照してください。

rulesetId: 設定するためのルールセットのID。

メソッドチェーンのためにAxeDevtoolsMatcherを返します。

com.deque.html.axedevtools.matchers.IsAccessible はAxeDevtoolsMatcherを拡張します

axeアクセシビリティチェックを実行します。

• アクセシビリティチェックを実行します：
  • assertThat(page, isAxeClean())
• 次を使用してコンテキストを定義します：（これらを使用せずにドキュメント全体をチェック）
  • within(String...)
  • within(Selector...)
  • excluding(String...)
  • excluding(Selector...)
• 次を使用してオプションを定義します：（axe基準で定義されたすべてのルールをチェックするにはこのステップをスキップ）
  • accordingTo(String...)
  • checkingOnly(String...)
  • checking(String...)
  • skipping(String...)
• 監査スイートの設定を定義します：（このステップをスキップしてデフォルトの監査設定場所を使用）
  • forConfig(URL)
  • forConfig(String)
• 設定スイートのログオプションを定義します：（デフォルトでは結果ログを生成しません）
  • logResults(AxeReportingOptions)

アクセシビリティコンテキストとオプションをチェーンできます：

assertThat(axeDevtoolsSelenium, isAxeClean()
  .within("#header")
  .within("#footer")
  .excluding(".graphics")
  .accordingTo("wcag2a", "wcag2aa"));

static IsAccessible isAxeClean()

Webページのアクセシビリティをアサートします。IsAxeCleanインスタンスを取得する唯一の方法。

新しいisAxeCleanベースのマッチャーを返します。

com.deque.html.axedevtools.matchers.IsAuditedForAccessibility はAxeDevtoolsMatcherを拡張します

ページのアクセシビリティの監査を実施します。 監査はアクセシビリティの問題をtarget/axe-report/accessibility-check.logに記録し、結果のjson出力をtarget/axe-report/accessibility-check.jsonに作成します。

このマッチャーは決してアサーション例外をスローしません。 回帰性の監視結果は、このマッチャーを使用した場合、テストスイートの失敗/成功以外で処理する必要があります。

• アクセシビリティ監査を実行します：
  • assertThat(page, isAuditedForAccessibility())
• 次を使用してコンテキストを定義します：（これらを使用せずにドキュメント全体をチェック）
  • within(String...)
  • within(Selector...)
  • excluding(String...)
  • excluding(Selector...)
• 次を使用してオプションを定義します：（axe基準で定義されたすべてのルールをチェックするにはこのステップをスキップ）
  • accordingTo(String...)
  • checkingOnly(String...)
  • checking(String...)
  • skipping(String...)
• 監査スイートの設定を定義します：（このステップをスキップしてデフォルトの監査設定場所を使用）
  • forConfig(URL)
  • forConfig(String)
• 設定スイートのログオプションを定義します：（デフォルトでは結果ログを生成しません）
  • logResults(AxeReportingOptions)

アクセシビリティコンテキストとオプションをチェーンできます：

assertThat(axeDevtoolsSelenium, isAuditedForAccessibility()
  .within("#header")
  .within("#footer")
  .excluding(".graphics")
  .accordingTo("wcag2a", "wcag2aa"));

static IsAuditedForAccessibility isAuditedForAccessibility()

Webページがアクセシビリティのために監査されていることをアサートします。IsAuditedForAccessibilityインスタンスを取得する唯一の方法。

新しいisAuditedForAccessibilityベースのマッチャーを返します。

interface com.deque.html.axedevtools.matchers.selectors.Selector

セレクタが実装するインターフェース。

com.deque.html.axedevtools.matchers.selectors.ElementSelector はSelectorを実装します

ElementSelector(final String cssSelector)

CSSセレクタ用のセレクタを作成します。

cssSelector: CSSセレクタ。

com.deque.html.axedevtools.matchers.selectors.IFrameSelector はSelectorを実装します

IFrameSelector(final String frameSelector, final String cssSelector)

iFrameセレクタを作成します。

frameSelector: ページ上のフレームの位置を表すCSSセレクタ。

cssSelector: フレーム内でアクセシビリティテストを実行するためのウェブ要素を表すCSSセレクタ。

IFrameSelector(最終 String frameSelector, 最終 Selector selector)

iFrameセレクターを作成します。

frameSelector: ページ上のフレームの位置を表すCSSセレクター。

selector: 他の{@link IFrameSelector}、または{@link ElementSelector}を表すセレクター