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