1 /* 2 * Copyright (C) 2021 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 package android.util; 17 18 import android.annotation.NonNull; 19 import android.annotation.Nullable; 20 21 import java.io.PrintWriter; 22 23 /** 24 * Represents an object whose state can be dumped into a {@link PrintWriter}. 25 */ 26 public interface Dumpable { 27 28 /** 29 * Gets the name of the {@link Dumpable}. 30 * 31 * @return class name, by default. 32 */ 33 @NonNull getDumpableName()34 default String getDumpableName() { 35 return getClass().getName(); 36 } 37 38 /** 39 * Dumps the internal state into the given {@code writer}. 40 * 41 * @param writer writer to be written to 42 * @param args optional list of arguments 43 */ dump(@onNull PrintWriter writer, @Nullable String[] args)44 void dump(@NonNull PrintWriter writer, @Nullable String[] args); 45 } 46