restconf/restconf-nb/src/main/java/org/opendaylight/restconf/server/spi/MaxDepthNormalizedNodeWriterFactory.java

   1 /*
   2  * Copyright (c) 2024 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.restconf.server.spi;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.base.MoreObjects.ToStringHelper;
  13 import org.eclipse.jdt.annotation.NonNullByDefault;
  14 import org.opendaylight.restconf.api.query.DepthParam;
  15 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  16
  17 /**
  18  * A {@link NormalizedNodeWriterFactory} returning a {@link NormalizedNodeWriter} which emits the data only to
  19  *  a certain
  20  * depth.
  21  */
  22 @NonNullByDefault
  23 final class MaxDepthNormalizedNodeWriterFactory extends NormalizedNodeWriterFactory {
  24     private final DepthParam depth;
  25
  26     MaxDepthNormalizedNodeWriterFactory(final DepthParam depth) {
  27         this.depth = requireNonNull(depth);
  28     }
  29
  30     @Override
  31     protected NormalizedNodeWriter newWriter(final NormalizedNodeStreamWriter streamWriter) {
  32         return NormalizedNodeWriter.forStreamWriter(streamWriter, depth);
  33     }
  34
  35     @Override
  36     protected ToStringHelper addToStringAttributes(final ToStringHelper helper) {
  37         return helper.add("depth", depth.value());
  38     }
  39 }