codec/yang-data-codec-gson/src/main/java/org/opendaylight/yangtools/yang/data/codec/gson/JSONInstanceIdentifierCodec.java

   1 /*
   2  * Copyright (c) 2014 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.codec.gson;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.gson.stream.JsonWriter;
  14 import java.io.IOException;
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.opendaylight.yangtools.yang.common.QName;
  17 import org.opendaylight.yangtools.yang.common.QNameModule;
  18 import org.opendaylight.yangtools.yang.common.XMLNamespace;
  19 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  20 import org.opendaylight.yangtools.yang.data.util.AbstractModuleStringInstanceIdentifierCodec;
  21 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
  22 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  23 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  24 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  25 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  26 import org.opendaylight.yangtools.yang.model.api.Module;
  27 import org.opendaylight.yangtools.yang.model.util.LeafrefResolver;
  28
  29 abstract sealed class JSONInstanceIdentifierCodec extends AbstractModuleStringInstanceIdentifierCodec
  30         implements JSONCodec<YangInstanceIdentifier> {
  31     static final class Lhotka02 extends JSONInstanceIdentifierCodec {
  32         Lhotka02(final EffectiveModelContext context, final JSONCodecFactory jsonCodecFactory) {
  33             super(context, jsonCodecFactory);
  34         }
  35     }
  36
  37     static final class RFC7951 extends JSONInstanceIdentifierCodec {
  38         RFC7951(final EffectiveModelContext context, final JSONCodecFactory jsonCodecFactory) {
  39             super(context, jsonCodecFactory);
  40         }
  41
  42         @Override
  43         protected StringBuilder appendQName(final StringBuilder sb, final QName qname, final QNameModule lastModule) {
  44             return qname.getModule().equals(lastModule) ? sb.append(qname.getLocalName())
  45                 : super.appendQName(sb, qname, lastModule);
  46         }
  47
  48         @Override
  49         protected QName createQName(final QNameModule lastModule, final String localName) {
  50             checkArgument(lastModule != null, "Unprefixed leading name %s", localName);
  51             return QName.create(lastModule, localName);
  52         }
  53     }
  54
  55     private final @NonNull DataSchemaContextTree dataContextTree;
  56     private final JSONCodecFactory codecFactory;
  57     private final EffectiveModelContext context;
  58
  59     JSONInstanceIdentifierCodec(final EffectiveModelContext context, final JSONCodecFactory jsonCodecFactory) {
  60         this.context = requireNonNull(context);
  61         dataContextTree = DataSchemaContextTree.from(context);
  62         codecFactory = requireNonNull(jsonCodecFactory);
  63     }
  64
  65     @Override
  66     protected final Module moduleForPrefix(final String prefix) {
  67         final var modules = context.findModules(prefix).iterator();
  68         return modules.hasNext() ? modules.next() : null;
  69     }
  70
  71     @Override
  72     protected final String prefixForNamespace(final XMLNamespace namespace) {
  73         final var modules = context.findModules(namespace).iterator();
  74         return modules.hasNext() ? modules.next().getName() : null;
  75     }
  76
  77     @Override
  78     protected final DataSchemaContextTree getDataContextTree() {
  79         return dataContextTree;
  80     }
  81
  82     @Override
  83     protected final Object deserializeKeyValue(final DataSchemaNode schemaNode, final LeafrefResolver resolver,
  84             final String value) {
  85         requireNonNull(schemaNode, "schemaNode cannot be null");
  86         if (schemaNode instanceof LeafSchemaNode leafSchemaNode) {
  87             return codecFactory.codecFor(leafSchemaNode, resolver).parseValue(null, value);
  88         } else if (schemaNode instanceof LeafListSchemaNode leafListSchemaNode) {
  89             return codecFactory.codecFor(leafListSchemaNode, resolver).parseValue(null, value);
  90         }
  91         throw new IllegalArgumentException("schemaNode " + schemaNode
  92                 + " must be of type LeafSchemaNode or LeafListSchemaNode");
  93     }
  94
  95     @Override
  96     public final Class<YangInstanceIdentifier> getDataType() {
  97         return YangInstanceIdentifier.class;
  98     }
  99
 100     @Override
 101     public final YangInstanceIdentifier parseValue(final Object ctx, final String str) {
 102         return deserialize(str);
 103     }
 104
 105     @Override
 106     public final void writeValue(final JsonWriter ctx, final YangInstanceIdentifier value) throws IOException {
 107         ctx.value(serialize(value));
 108     }
 109 }