yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/NormalizableAnydata.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.api.schema;
   9
  10 import com.google.common.annotations.Beta;
  11 import org.eclipse.jdt.annotation.NonNullByDefault;
  12 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  13 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  14
  15 /**
  16  * An {@link AnydataNode#getValueObjectModel() anydata value object model} which can be normalized to
  17  * {@link NormalizedAnydata} when provided with proper context.
  18  */
  19 @Beta
  20 @NonNullByDefault
  21 public interface NormalizableAnydata {
  22     /**
  23      * Attempt to interpret this anydata content in the context of specified tree and node.
  24      *
  25      * @param schemaContext Schema context
  26      * @param contextNode Corresponding schema node
  27      * @return Normalized anydata instance
  28      * @throws NullPointerException if any argument is null
  29      * @throws AnydataNormalizationException if this data cannot be interpreted in the requested context
  30      */
  31     NormalizedAnydata normalizeTo(SchemaContext schemaContext, DataSchemaNode contextNode)
  32             throws AnydataNormalizationException;
  33 }