yang/yang-data-codec-xml/src/main/java/org/opendaylight/yangtools/yang/data/codec/xml/XmlCodecFactory.java

   1 /*
   2  * Copyright (c) 2016 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
   9 package org.opendaylight.yangtools.yang.data.codec.xml;
  10
  11 import static com.google.common.base.Verify.verifyNotNull;
  12 import static java.util.Objects.requireNonNull;
  13
  14 import com.google.common.annotations.Beta;
  15 import java.util.List;
  16 import org.opendaylight.yangtools.rcf8528.data.util.EmptyMountPointContext;
  17 import org.opendaylight.yangtools.rfc8528.data.api.MountPointContext;
  18 import org.opendaylight.yangtools.yang.common.QNameModule;
  19 import org.opendaylight.yangtools.yang.data.impl.codec.AbstractIntegerStringCodec;
  20 import org.opendaylight.yangtools.yang.data.impl.codec.BinaryStringCodec;
  21 import org.opendaylight.yangtools.yang.data.impl.codec.BitsStringCodec;
  22 import org.opendaylight.yangtools.yang.data.impl.codec.BooleanStringCodec;
  23 import org.opendaylight.yangtools.yang.data.impl.codec.DecimalStringCodec;
  24 import org.opendaylight.yangtools.yang.data.impl.codec.EnumStringCodec;
  25 import org.opendaylight.yangtools.yang.data.impl.codec.StringStringCodec;
  26 import org.opendaylight.yangtools.yang.data.util.codec.AbstractCodecFactory;
  27 import org.opendaylight.yangtools.yang.data.util.codec.SharedCodecCache;
  28 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  29 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  30 import org.opendaylight.yangtools.yang.model.api.TypeAware;
  31 import org.opendaylight.yangtools.yang.model.api.type.BinaryTypeDefinition;
  32 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
  33 import org.opendaylight.yangtools.yang.model.api.type.BooleanTypeDefinition;
  34 import org.opendaylight.yangtools.yang.model.api.type.DecimalTypeDefinition;
  35 import org.opendaylight.yangtools.yang.model.api.type.EmptyTypeDefinition;
  36 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
  37 import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
  38 import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
  39 import org.opendaylight.yangtools.yang.model.api.type.Int16TypeDefinition;
  40 import org.opendaylight.yangtools.yang.model.api.type.Int32TypeDefinition;
  41 import org.opendaylight.yangtools.yang.model.api.type.Int64TypeDefinition;
  42 import org.opendaylight.yangtools.yang.model.api.type.Int8TypeDefinition;
  43 import org.opendaylight.yangtools.yang.model.api.type.StringTypeDefinition;
  44 import org.opendaylight.yangtools.yang.model.api.type.Uint16TypeDefinition;
  45 import org.opendaylight.yangtools.yang.model.api.type.Uint32TypeDefinition;
  46 import org.opendaylight.yangtools.yang.model.api.type.Uint64TypeDefinition;
  47 import org.opendaylight.yangtools.yang.model.api.type.Uint8TypeDefinition;
  48 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
  49 import org.opendaylight.yangtools.yang.model.api.type.UnknownTypeDefinition;
  50 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
  51
  52 /**
  53  * A thread-safe factory for instantiating {@link XmlCodec}s.
  54  */
  55 @Beta
  56 public final class XmlCodecFactory extends AbstractCodecFactory<XmlCodec<?>> {
  57     private final MountPointContext mountCtx;
  58
  59     private XmlCodecFactory(final MountPointContext mountCtx) {
  60         super(mountCtx.getEffectiveModelContext(), new SharedCodecCache<>());
  61         this.mountCtx = requireNonNull(mountCtx);
  62     }
  63
  64     MountPointContext mountPointContext() {
  65         return mountCtx;
  66     }
  67
  68     /**
  69      * Instantiate a new codec factory attached to a particular context.
  70      *
  71      * @param context MountPointContext to which the factory should be bound
  72      * @return A codec factory instance.
  73      */
  74     public static XmlCodecFactory create(final MountPointContext context) {
  75         return new XmlCodecFactory(context);
  76     }
  77
  78     /**
  79      * Instantiate a new codec factory attached to a particular context.
  80      *
  81      * @param context SchemaContext to which the factory should be bound
  82      * @return A codec factory instance.
  83      */
  84     public static XmlCodecFactory create(final EffectiveModelContext context) {
  85         return create(new EmptyMountPointContext(context));
  86     }
  87
  88     @Override
  89     protected XmlCodec<?> binaryCodec(final BinaryTypeDefinition type) {
  90         return new QuotedXmlCodec<>(BinaryStringCodec.from(type));
  91     }
  92
  93     @Override
  94     protected XmlCodec<?> booleanCodec(final BooleanTypeDefinition type) {
  95         return new BooleanXmlCodec(BooleanStringCodec.from(type));
  96     }
  97
  98     @Override
  99     protected XmlCodec<?> bitsCodec(final BitsTypeDefinition type) {
 100         return new QuotedXmlCodec<>(BitsStringCodec.from(type));
 101     }
 102
 103     @Override
 104     protected XmlCodec<?> emptyCodec(final EmptyTypeDefinition type) {
 105         return EmptyXmlCodec.INSTANCE;
 106     }
 107
 108     @Override
 109     protected XmlCodec<?> enumCodec(final EnumTypeDefinition type) {
 110         return new QuotedXmlCodec<>(EnumStringCodec.from(type));
 111     }
 112
 113     @Override
 114     protected XmlCodec<?> identityRefCodec(final IdentityrefTypeDefinition type, final QNameModule module) {
 115         return new IdentityrefXmlCodec(getEffectiveModelContext(), module);
 116     }
 117
 118     @Override
 119     protected XmlCodec<?> instanceIdentifierCodec(final InstanceIdentifierTypeDefinition type) {
 120         return new XmlStringInstanceIdentifierCodec(getEffectiveModelContext(), this);
 121     }
 122
 123     @Override
 124     protected XmlCodec<?> int8Codec(final Int8TypeDefinition type) {
 125         return new NumberXmlCodec<>(AbstractIntegerStringCodec.from(type));
 126     }
 127
 128     @Override
 129     protected XmlCodec<?> int16Codec(final Int16TypeDefinition type) {
 130         return new NumberXmlCodec<>(AbstractIntegerStringCodec.from(type));
 131     }
 132
 133     @Override
 134     protected XmlCodec<?> int32Codec(final Int32TypeDefinition type) {
 135         return new NumberXmlCodec<>(AbstractIntegerStringCodec.from(type));
 136     }
 137
 138     @Override
 139     protected XmlCodec<?> int64Codec(final Int64TypeDefinition type) {
 140         return new NumberXmlCodec<>(AbstractIntegerStringCodec.from(type));
 141     }
 142
 143     @Override
 144     protected XmlCodec<?> decimalCodec(final DecimalTypeDefinition type) {
 145         return new NumberXmlCodec<>(DecimalStringCodec.from(type));
 146     }
 147
 148     @Override
 149     protected XmlCodec<?> stringCodec(final StringTypeDefinition type) {
 150         return new QuotedXmlCodec<>(StringStringCodec.from(type));
 151     }
 152
 153     @Override
 154     protected XmlCodec<?> uint8Codec(final Uint8TypeDefinition type) {
 155         return new NumberXmlCodec<>(AbstractIntegerStringCodec.from(type));
 156     }
 157
 158     @Override
 159     protected XmlCodec<?> uint16Codec(final Uint16TypeDefinition type) {
 160         return new NumberXmlCodec<>(AbstractIntegerStringCodec.from(type));
 161     }
 162
 163     @Override
 164     protected XmlCodec<?> uint32Codec(final Uint32TypeDefinition type) {
 165         return new NumberXmlCodec<>(AbstractIntegerStringCodec.from(type));
 166     }
 167
 168     @Override
 169     protected XmlCodec<?> uint64Codec(final Uint64TypeDefinition type) {
 170         return new NumberXmlCodec<>(AbstractIntegerStringCodec.from(type));
 171     }
 172
 173     @Override
 174     protected XmlCodec<?> unionCodec(final UnionTypeDefinition type, final List<XmlCodec<?>> codecs) {
 175         return UnionXmlCodec.create(type, codecs);
 176     }
 177
 178     @Override
 179     protected XmlCodec<?> unknownCodec(final UnknownTypeDefinition type) {
 180         return NullXmlCodec.INSTANCE;
 181     }
 182
 183     <T extends SchemaNode & TypeAware> XmlCodec<?> codecFor(final T currentNode) {
 184         return codecFor(currentNode, type -> verifyNotNull(
 185             SchemaContextUtil.getBaseTypeForLeafRef(type, getEffectiveModelContext(), currentNode),
 186             "Unable to find base type for leafref node %s type %s.", currentNode, type));
 187     }
 188 }