common/concepts/src/main/java/org/opendaylight/yangtools/concepts/PrettyTreeAware.java

   1 /*
   2  * Copyright (c) 2021 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.concepts;
   9
  10 import org.eclipse.jdt.annotation.NonNullByDefault;
  11
  12 /**
  13  * Utility interface to bridge structures which can be formatted via {@link PrettyTree}.
  14  */
  15 @NonNullByDefault
  16 public interface PrettyTreeAware {
  17     /**
  18      * Return a {@link PrettyTree} view of this object.
  19      *
  20      * @return A {@link PrettyTree}.
  21      */
  22     PrettyTree prettyTree();
  23 }