yang/yang-data-util/src/main/java/org/opendaylight/yangtools/yang/data/util/NormalizedAnydata.java

   1 /*
   2  * Copyright (c) 2019 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.util;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.Beta;
  13 import com.google.common.base.MoreObjects;
  14 import com.google.common.base.MoreObjects.ToStringHelper;
  15 import java.io.IOException;
  16 import org.eclipse.jdt.annotation.NonNullByDefault;
  17 import org.eclipse.jdt.annotation.Nullable;
  18 import org.opendaylight.yangtools.concepts.Immutable;
  19 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  20 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  21 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
  22 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  23 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  24 import org.opendaylight.yangtools.yang.model.api.SchemaContextProvider;
  25
  26 /**
  27  * The contents of an {@code anydata} node in a normalized format. This representation acts as a schema-bound bridge
  28  * between the various (mostly parser-based) representations.
  29  *
  30  * <p>
  31  * Note this class (and all of its subclasses) rely on identity for their equality contract.
  32  */
  33 @Beta
  34 @NonNullByDefault
  35 public class NormalizedAnydata implements Immutable, SchemaContextProvider {
  36     private final SchemaContext schemaContext;
  37     private final DataSchemaNode contextNode;
  38     private final NormalizedNode<?, ?> data;
  39
  40     public NormalizedAnydata(final SchemaContext schemaContext, final DataSchemaNode contextNode,
  41             final NormalizedNode<?, ?> data) {
  42         this.schemaContext = requireNonNull(schemaContext);
  43         this.contextNode = requireNonNull(contextNode);
  44         this.data = requireNonNull(data);
  45     }
  46
  47     @Override
  48     public final SchemaContext getSchemaContext() {
  49         return schemaContext;
  50     }
  51
  52     public final DataSchemaNode getContextNode() {
  53         return contextNode;
  54     }
  55
  56     public final NormalizedNode<?, ?> getData() {
  57         return data;
  58     }
  59
  60     public final void writeTo(final NormalizedNodeStreamWriter writer) throws IOException {
  61         writeTo(writer, true);
  62     }
  63
  64     public void writeTo(final NormalizedNodeStreamWriter writer, final boolean orderKeyLeaves) throws IOException {
  65         NormalizedNodeWriter.forStreamWriter(writer, orderKeyLeaves).write(data).flush();
  66     }
  67
  68     @Override
  69     public final int hashCode() {
  70         return super.hashCode();
  71     }
  72
  73     @Override
  74     public final boolean equals(final @Nullable Object obj) {
  75         return super.equals(obj);
  76     }
  77
  78     @Override
  79     public final String toString() {
  80         return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
  81     }
  82
  83     protected ToStringHelper addToStringAttributes(final ToStringHelper helper) {
  84         return helper.add("schemaConteext", schemaContext).add("node", contextNode).add("data", data);
  85     }
  86 }