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 20 /** 21 * Represents a container that manages {@link Dumpable dumpables}. 22 */ 23 public interface DumpableContainer { 24 25 /** 26 * Adds the given {@link Dumpable dumpable} to the container. 27 * 28 * <p>If a dumpable with the same {@link Dumpable#getDumpableName() name} was added before, this 29 * call is ignored. 30 * 31 * @param dumpable dumpable to be added. 32 * 33 * @throws IllegalArgumentException if the {@link Dumpable#getDumpableName() dumpable name} is 34 * {@code null}. 35 * 36 * @return {@code true} if the dumpable was added, {@code false} if the call was ignored. 37 */ addDumpable(@onNull Dumpable dumpable)38 boolean addDumpable(@NonNull Dumpable dumpable); 39 40 /** 41 * Removes the given {@link Dumpable dumpable} from the container. 42 * 43 * @param dumpable dumpable to be removed. 44 * 45 * @return {@code true} if the dumpable was removed, {@code false} if it was not previously 46 * {@link #addDumpable(Dumpable) added} with the same identify (object reference) and 47 * {@link Dumpable#getDumpableName() name}. 48 */ removeDumpable(@onNull Dumpable dumpable)49 boolean removeDumpable(@NonNull Dumpable dumpable); 50 } 51