Dumper.java

/*
 * Copyright (C) 2016 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.google.android.exoplayer2.testutil;

import com.google.android.exoplayer2.C;
import java.util.Arrays;
import java.util.Locale;

/**
 * Helper utility to dump field values.
 */
public final class Dumper {

  /**
   * Provides custom dump method.
   */
  public interface Dumpable {
    /**
     * Dumps the fields of the object using the {@code dumper}.
     * @param dumper The {@link Dumper} to be used to dump fields.
     */
    void dump(Dumper dumper);
  }

  private static final int INDENT_SIZE_IN_SPACES = 2;

  private final StringBuilder sb;
  private int indent;

  public Dumper() {
    sb = new StringBuilder();
  }

  public Dumper add(String field, Object value) {
    return addString(field + " = " + value + '\n');
  }

  public Dumper add(Dumpable object) {
    object.dump(this);
    return this;
  }

  public Dumper add(String field, byte[] value) {
    String string = String.format(Locale.US, "%s = length %d, hash %X\n", field, value.length,
        Arrays.hashCode(value));
    return addString(string);
  }

  public Dumper addTime(String field, long time) {
    return add(field, time == C.TIME_UNSET ? "UNSET TIME" : time);
  }

  public Dumper startBlock(String name) {
    addString(name + ":\n");
    indent += INDENT_SIZE_IN_SPACES;
    return this;
  }

  public Dumper endBlock() {
    indent -= INDENT_SIZE_IN_SPACES;
    return this;
  }

  @Override
  public String toString() {
    return sb.toString();
  }

  private Dumper addString(String string) {
    for (int i = 0; i < indent; i++) {
      sb.append(' ');
    }
    sb.append(string);
    return this;
  }

}