com.deque.axe.android.AxeRuleResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of axe-android Show documentation
Axe for Android
The newest version!
package com.deque.axe.android;

import android.support.annotation.NonNull;

import com.deque.axe.android.constants.AxeImpact;
import com.deque.axe.android.constants.AxeStatus;
import com.deque.axe.android.utils.AxeTree;
import com.deque.axe.android.utils.JsonSerializable;
import com.deque.axe.android.wrappers.AxeProps;
import com.google.gson.ExclusionStrategy;
import com.google.gson.FieldAttributes;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.LongSerializationPolicy;

public class AxeRuleResult implements Comparable, JsonSerializable {

  /**
   * A simple interface that allows us to query AxeResult objects.
   */
  public interface Matcher {
    boolean matches(AxeRuleResult ruleResult);
  }

  /**
   * A unique identifier for an AxeView within a given set of axeRuleResults.
   */
  public final String axeViewId;

  /**
   * The properties used in determining that the AxeView was in violation.
   */
  public final AxeProps props;

  /**
   * The ID of the rule that generated the result. Very often also the ClassName of the Rule.
   */
  public final String ruleId;

  /**
   * The basic description of the Rule that failed.
   */
  public final String ruleSummary;

  /**
   * The impact of the rule [0=MINOR, 1=MODERATE, 2=SERIOUS, 3=CRITICAL, 4=BLOCKER].
   */
  public @AxeImpact int impact;

  /**
   * One of [PASS, FAIL, INCOMPLETE, INAPPLICABLE].
   */
  public final @AxeStatus String status;


  AxeRuleResult(
      @AxeStatus String status,
      AxeRule axeRule,
      AxeProps axeProps,
      AxeTree axeView
  ) {
    this.ruleId = axeRule != null ? axeRule.id : null;
    this.ruleSummary = axeRule != null ? axeRule.summary : null;
    this.props = axeProps;
    this.status = status;
    this.axeViewId = axeView == null ? null : axeView.getNodeId();
    this.impact = axeRule != null ? axeRule.impact : 0;
  }

  @Override
  public Gson getGsonComparison() {
    return new GsonBuilder()
        .setPrettyPrinting()
        .serializeNulls()
        .setLongSerializationPolicy(LongSerializationPolicy.STRING)
        .addSerializationExclusionStrategy(new ExclusionStrategy() {

          @Override
          public boolean shouldSkipField(FieldAttributes f) {
            return "props".equalsIgnoreCase(f.getName());
          }

          @Override
          public boolean shouldSkipClass(Class clazz) {
            return false;
          }
        }).create();
  }

  @Override
  public int hashCode() {
    return JsonSerializable.hashCode(this);
  }

  @Override
  public int compareTo(@NonNull AxeRuleResult o) {
    return JsonSerializable.compareTo(this, o);
  }

  @Override
  public boolean equals(Object object) {

    if (object == this) {
      return true;
    }

    if (!(object instanceof AxeRuleResult)) {
      return false;
    }

    final AxeRuleResult axeRuleResult = (AxeRuleResult) object;

    if (impact != axeRuleResult.impact) {
      return false;
    }

    return axeRuleResult.compareTo(this) == 0;
  }

  @Override
  public String toString() {
    return toJson();
  }
}