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

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. 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 java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.Beta;
  13 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  14 import java.util.ArrayDeque;
  15 import java.util.Deque;
  16 import javax.xml.transform.dom.DOMSource;
  17 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  18 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  19 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  20 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  21 import org.slf4j.Logger;
  22 import org.slf4j.LoggerFactory;
  23
  24 /**
  25  * A {@link NormalizedNodeStreamWriter} which logs the events into a {@link Logger}.
  26  */
  27 @Beta
  28 public final class LoggingNormalizedNodeStreamWriter implements NormalizedNodeStreamWriter {
  29     private static final Logger LOG = LoggerFactory.getLogger(LoggingNormalizedNodeStreamWriter.class);
  30     private static final int DEFAULT_INDENT_SIZE = 2;
  31
  32     private final Deque<String> indent = new ArrayDeque<>();
  33     private final String indentStr;
  34
  35     public LoggingNormalizedNodeStreamWriter() {
  36         this(DEFAULT_INDENT_SIZE);
  37     }
  38
  39     public LoggingNormalizedNodeStreamWriter(final int indentSize) {
  40         this.indentStr = " ".repeat(indentSize);
  41         indent.push("");
  42     }
  43
  44     private String ind() {
  45         return indent.peek();
  46     }
  47
  48     private void decIndent() {
  49         indent.pop();
  50     }
  51
  52     private void incIndent() {
  53         indent.push(ind() + indentStr);
  54     }
  55
  56     @Override
  57     public void startUnkeyedListItem(final NodeIdentifier name, final int childSizeHint) {
  58         LOG.debug("{}{}[](no key)", ind(), name);
  59         incIndent();
  60     }
  61
  62     @Override
  63     public void startUnkeyedList(final NodeIdentifier name, final int childSizeHint) {
  64         LOG.debug("{}{}(no key)", ind(), name);
  65         incIndent();
  66     }
  67
  68     @Override
  69     public void startOrderedMapNode(final NodeIdentifier name, final int childSizeHint) {
  70         startMapNode(name, childSizeHint);
  71     }
  72
  73     @Override
  74     public void startMapNode(final NodeIdentifier name, final int childSizeHint) {
  75         LOG.debug("{}{}(key)", ind(), name);
  76         incIndent();
  77     }
  78
  79     @Override
  80     public void startMapEntryNode(final NodeIdentifierWithPredicates identifier, final int childSizeHint) {
  81         LOG.debug("{}{}[](key)", ind(), identifier);
  82         incIndent();
  83     }
  84
  85     @Override
  86     public void startLeafSet(final NodeIdentifier name, final int childSizeHint) {
  87         LOG.debug("{}{}(leaf-list)", ind(), name);
  88         incIndent();
  89     }
  90
  91     @Override
  92     public void startOrderedLeafSet(final NodeIdentifier name, final int childSizeHint) {
  93         startLeafSet(name, childSizeHint);
  94     }
  95
  96     @Override
  97     public void startContainerNode(final NodeIdentifier name, final int childSizeHint) {
  98         LOG.debug("{}{}(container)", ind(), name);
  99         incIndent();
 100     }
 101
 102     @Override
 103     public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) {
 104         LOG.debug("{}{}(choice)", ind(), name);
 105         incIndent();
 106     }
 107
 108     @Override
 109     public void startAugmentationNode(final AugmentationIdentifier identifier) {
 110         LOG.debug("{}{}(augmentation)", ind(), identifier);
 111         incIndent();
 112     }
 113
 114     @Override
 115     public void startLeafSetEntryNode(final NodeWithValue<?> name) {
 116         LOG.debug("{}{}(entry}", ind(), name.getNodeType());
 117         incIndent();
 118     }
 119
 120     @Override
 121     public void startLeafNode(final NodeIdentifier name) {
 122         LOG.debug("{}{}(leaf)", ind(), name);
 123         incIndent();
 124     }
 125
 126     @Override
 127     public void endNode() {
 128         decIndent();
 129         LOG.debug("{}(end)", ind());
 130     }
 131
 132     @Override
 133     public boolean startAnyxmlNode(final NodeIdentifier name, final Class<?> objectModel) {
 134         LOG.debug("{}{}(anyxml)", ind(), name);
 135         incIndent();
 136         return true;
 137     }
 138
 139     @Override
 140     public boolean startAnydataNode(final NodeIdentifier name, final Class<?> objectModel) {
 141         LOG.debug("{}{}(anydata)", ind(), name);
 142         incIndent();
 143         return true;
 144     }
 145
 146     @Override
 147     public void flush() {
 148         LOG.trace("<<FLUSH>>");
 149     }
 150
 151     @Override
 152     public void close() {
 153         LOG.debug("<<END-OF-STREAM>>");
 154     }
 155
 156     @Override
 157     @SuppressFBWarnings("SLF4J_SIGN_ONLY_FORMAT")
 158     public void scalarValue(final Object value) {
 159         LOG.debug("{}({})={}", ind(), requireNonNull(value).getClass().getSimpleName(), value);
 160     }
 161
 162     @Override
 163     public void domSourceValue(final DOMSource value) {
 164         scalarValue(value);
 165     }
 166 }