leakcanary-watcher/src/main/java/com/squareup/leakcanary/LeakReference.java

/*
 * Copyright (C) 2015 Square, Inc.
 *
 * 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.squareup.leakcanary;

import java.io.Serializable;

/**
 * A single field in a {@link LeakTraceElement}.
 */
public final class LeakReference implements Serializable {

  public final LeakTraceElement.Type type;
  public final String name;
  public final String value;

  public LeakReference(LeakTraceElement.Type type, String name, String value) {
    this.type = type;
    this.name = name;
    this.value = value;
  }

  public String getDisplayName() {
    switch (type) {
      case ARRAY_ENTRY:
        return "[" + name + "]";
      case STATIC_FIELD:
      case INSTANCE_FIELD:
        return name;
      case LOCAL:
        return "<Java Local>";
      default:
        throw new IllegalStateException(
            "Unexpected type " + type + " name = " + name + " value = " + value);
    }
  }

  @Override public String toString() {
    switch (type) {
      case ARRAY_ENTRY:
      case INSTANCE_FIELD:
        return getDisplayName() + " = " + value;
      case STATIC_FIELD:
        return "static " + getDisplayName() + " = " + value;
      case LOCAL:
        return getDisplayName();
      default:
        throw new IllegalStateException(
            "Unexpected type " + type + " name = " + name + " value = " + value);
    }
  }
}