Populate data/ hierarchy
[yangtools.git] / data / yang-data-impl / src / main / java / org / opendaylight / yangtools / yang / data / impl / schema / AbstractNormalizableAnydata.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.impl.schema;
9
10 import com.google.common.annotations.Beta;
11 import com.google.common.base.MoreObjects;
12 import com.google.common.base.MoreObjects.ToStringHelper;
13 import java.io.IOException;
14 import org.eclipse.jdt.annotation.NonNullByDefault;
15 import org.opendaylight.yangtools.rfc7952.data.util.ImmutableMetadataNormalizedAnydata;
16 import org.opendaylight.yangtools.yang.data.api.schema.AnydataNormalizationException;
17 import org.opendaylight.yangtools.yang.data.api.schema.NormalizableAnydata;
18 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
19 import org.opendaylight.yangtools.yang.data.util.ImmutableNormalizedAnydata;
20 import org.opendaylight.yangtools.yang.model.api.EffectiveStatementInference;
21
22 /**
23  * Abstract base class for implementing the NormalizableAnydata interface. This class provides the binding to
24  * NormalizedNodeStreamWriter.
25  */
26 @Beta
27 @NonNullByDefault
28 public abstract class AbstractNormalizableAnydata implements NormalizableAnydata {
29     @Override
30     public final ImmutableNormalizedAnydata normalizeTo(final EffectiveStatementInference inference)
31             throws AnydataNormalizationException {
32         final NormalizedNodeMetadataResult result = new NormalizedNodeMetadataResult();
33         final NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
34         try {
35             writeTo(streamWriter, inference);
36         } catch (IOException e) {
37             throw new AnydataNormalizationException("Failed to normalize anydata", e);
38         }
39
40         return ImmutableMetadataNormalizedAnydata.ofOptional(inference, result.getResult(), result.getMetadata());
41     }
42
43     @Override
44     public final String toString() {
45         return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
46     }
47
48     protected abstract ToStringHelper addToStringAttributes(ToStringHelper helper);
49
50     protected abstract void writeTo(NormalizedNodeStreamWriter streamWriter, EffectiveStatementInference inference)
51         throws IOException;
52 }