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