tools/ahat/src/main/com/android/ahat/heapdump/DiffedFieldValue.java

/*
 * Copyright (C) 2017 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.ahat.heapdump;

import java.util.Objects;

/**
 * Used by the DiffedField class to return the result of diffing two
 * collections of fields.
 */
public class DiffedFieldValue {
  /**
   * The name of the field.
   */
  public final String name;

  /**
   * The type of the field.
   */
  public final Type type;

  /**
   * The value of the field in the current heap dump.
   */
  public final Value current;

  /**
   * The value of the field in the baseline heap dump.
   */
  public final Value baseline;

  /**
   * Whether the field was added to, deleted from, or matched with a field in
   * the baseline heap dump.
   */
  public final Status status;

  /**
   * A status enum to indicate whether a field was added to, deleted from, or
   * matched with a field in the baseline heap dump.
   */
  public static enum Status {
    /**
     * The field exists in the current heap dump but not the baseline.
     */
    ADDED,

    /**
     * The field exists in both the current and baseline heap dumps.
     */
    MATCHED,

    /**
     * The field exists in the baseline heap dump but not the current.
     */
    DELETED
  };

  /**
   * Constructs a DiffedFieldValue where there are both current and baseline
   * fields.
   *
   * @param current the current field
   * @param baseline the baseline field
   * @return the constructed DiffedFieldValue
   */
  public static DiffedFieldValue matched(FieldValue current, FieldValue baseline) {
    return new DiffedFieldValue(current.name,
                                current.type,
                                current.value,
                                baseline.value,
                                Status.MATCHED);
  }

  /**
   * Constructs a DiffedFieldValue where there is no baseline field.
   *
   * @param current the current field
   * @return the constructed DiffedFieldValue
   */
  public static DiffedFieldValue added(FieldValue current) {
    return new DiffedFieldValue(current.name, current.type, current.value, null, Status.ADDED);
  }

  /**
   * Constructs a DiffedFieldValue where there is no current field.
   *
   * @param baseline the baseline field
   * @return the constructed DiffedFieldValue
   */
  public static DiffedFieldValue deleted(FieldValue baseline) {
    return new DiffedFieldValue(baseline.name, baseline.type, null, baseline.value, Status.DELETED);
  }

  private DiffedFieldValue(String name, Type type, Value current, Value baseline, Status status) {
    this.name = name;
    this.type = type;
    this.current = current;
    this.baseline = baseline;
    this.status = status;
  }

  @Override public int hashCode() {
    return Objects.hash(name, type, current, baseline, status);
  }

  @Override
  public boolean equals(Object otherObject) {
    if (otherObject instanceof DiffedFieldValue) {
      DiffedFieldValue other = (DiffedFieldValue)otherObject;
      return name.equals(other.name)
        && type.equals(other.type)
        && Objects.equals(current, other.current)
        && Objects.equals(baseline, other.baseline)
        && Objects.equals(status, other.status);
    }
    return false;
  }

  @Override
  public String toString() {
    switch (status) {
      case ADDED:
        return "(" + name + " " + type + " +" + current + ")";

      case MATCHED:
        return "(" + name + " " + type + " " + current + " " + baseline + ")";

      case DELETED:
        return "(" + name + " " + type + " -" + baseline + ")";

      default:
        // There are no other members.
        throw new AssertionError("unsupported enum member");
    }
  }
}