data/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/stream/FormattingNormalizedNodeStreamWriter.java

   1 /*
   2  * Copyright (c) 2022 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.yang.data.api.schema.stream;
   9
  10 import static com.google.common.base.Preconditions.checkState;
  11
  12 import com.google.common.annotations.Beta;
  13 import org.eclipse.jdt.annotation.NonNull;
  14 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  16 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  17
  18 /**
  19  * A {@link NormalizedNodeStreamWriter} which formats events into a String, available via #result().
  20  */
  21 @Beta
  22 public final class FormattingNormalizedNodeStreamWriter extends AbstractIndentingNormalizedNodeStreamWriter {
  23     private final StringBuilder sb = new StringBuilder();
  24
  25     private boolean closed;
  26
  27     public FormattingNormalizedNodeStreamWriter() {
  28         // Default constructor
  29     }
  30
  31     public FormattingNormalizedNodeStreamWriter(final int indentSize) {
  32         super(indentSize);
  33     }
  34
  35     /**
  36      * Return the formatted String result capturing the events which have been streamed into this writer.
  37      *
  38      * @return Formatted string
  39      * @throws IllegalStateException if this writer was not {@link #close()}d
  40      */
  41     public @NonNull String result() {
  42         checkState(closed, "Attempted to access the result of unclosed writer");
  43         return sb.toString();
  44     }
  45
  46     @Override
  47     public void flush() {
  48         // No-op
  49     }
  50
  51     @Override
  52     public void close() {
  53         closed = true;
  54     }
  55
  56     @Override
  57     void enterUnkeyedListItem(final NodeIdentifier name, final String indent) {
  58         sb.append(indent).append(name).append("[](no key)\n");
  59     }
  60
  61     @Override
  62     void enterUnkeyedList(final NodeIdentifier name, final String indent) {
  63         sb.append(indent).append(name).append("(no key)\n");
  64     }
  65
  66     @Override
  67     void enterMapNode(final NodeIdentifier name, final String indent) {
  68         sb.append(indent).append(name).append("(key)\n");
  69     }
  70
  71     @Override
  72     void enterMapEntryNode(final NodeIdentifierWithPredicates identifier, final String indent) {
  73         sb.append(indent).append(identifier).append("[](key)\n");
  74     }
  75
  76     @Override
  77     void enterLeafSet(final NodeIdentifier name, final String indent) {
  78         sb.append(indent).append(name).append("(leaf-list)\n");
  79     }
  80
  81     @Override
  82     void enterContainerNode(final NodeIdentifier name, final String indent) {
  83         sb.append(indent).append(name).append("(container)\n");
  84     }
  85
  86     @Override
  87     void enterChoiceNode(final NodeIdentifier name, final String indent) {
  88         sb.append(indent).append(name).append("(choice)\n");
  89     }
  90
  91     @Override
  92     void enterLeafSetEntryNode(final NodeWithValue<?> name, final String indent) {
  93         sb.append(indent).append(name.getNodeType()).append("(entry)\n");
  94     }
  95
  96     @Override
  97     void enterLeafNode(final NodeIdentifier name, final String indent) {
  98         sb.append(indent).append(name).append("(leaf)\n");
  99     }
 100
 101     @Override
 102     void enterAnyxmlNode(final NodeIdentifier name, final String indent) {
 103         sb.append(indent).append(name).append("(anyxml)\n");
 104     }
 105
 106     @Override
 107     void enterAnydataNode(final NodeIdentifier name, final String indent) {
 108         sb.append(indent).append(name).append("(anydata)\n");
 109     }
 110
 111     @Override
 112     void exitNode(final String indent) {
 113         sb.append(indent).append("(end)\n");
 114     }
 115
 116     @Override
 117     void scalarValue(final Object value, final String indent) {
 118         sb.append(indent).append('(').append(value.getClass().getSimpleName()).append(")=").append(value).append('\n');
 119     }
 120 }