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.eclipse.jdt.annotation.Nullable;
  15 import org.opendaylight.yangtools.yang.common.QNameModule;
  16 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  17 import org.opendaylight.yangtools.yang.data.api.schema.MountPointContext;
  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 public final class XmlCodecFactory extends AbstractCodecFactory<XmlCodec<?>> {
  52     private final @NonNull InstanceIdentifierXmlCodec instanceIdentifierCodec;
  53     private final @NonNull MountPointContext mountCtx;
  54     private final @Nullable PreferredPrefixes pref;
  55
  56     private XmlCodecFactory(final MountPointContext mountCtx, final boolean modelPrefixes) {
  57         super(mountCtx.getEffectiveModelContext(), new SharedCodecCache<>());
  58         this.mountCtx = requireNonNull(mountCtx);
  59         pref = modelPrefixes ? new PreferredPrefixes.Shared(getEffectiveModelContext()) : null;
  60         instanceIdentifierCodec = new InstanceIdentifierXmlCodec(this, pref);
  61     }
  62
  63     MountPointContext mountPointContext() {
  64         return mountCtx;
  65     }
  66
  67     /**
  68      * Instantiate a new codec factory attached to a particular context.
  69      *
  70      * @param context MountPointContext to which the factory should be bound
  71      * @return A codec factory instance.
  72      */
  73     public static XmlCodecFactory create(final MountPointContext context) {
  74         return create(context, false);
  75     }
  76
  77     /**
  78      * Instantiate a new codec factory attached to a particular context.
  79      *
  80      * @param context MountPointContext to which the factory should be bound
  81      * @param preferPrefixes prefer prefixes known to {@code context}
  82      * @return A codec factory instance.
  83      */
  84     public static XmlCodecFactory create(final MountPointContext context, final boolean preferPrefixes) {
  85         return new XmlCodecFactory(context, preferPrefixes);
  86     }
  87
  88     /**
  89      * Instantiate a new codec factory attached to a particular context.
  90      *
  91      * @param context SchemaContext to which the factory should be bound
  92      * @return A codec factory instance.
  93      */
  94     public static XmlCodecFactory create(final EffectiveModelContext context) {
  95         return create(context, false);
  96     }
  97
  98     /**
  99      * Instantiate a new codec factory attached to a particular context.
 100      *
 101      * @param context SchemaContext to which the factory should be bound
 102      * @param preferPrefixes prefer prefixes known to {@code context}
 103      * @return A codec factory instance.
 104      */
 105     public static XmlCodecFactory create(final EffectiveModelContext context, final boolean preferPrefixes) {
 106         return create(MountPointContext.of(requireNonNull(context)), preferPrefixes);
 107     }
 108
 109     @Override
 110     protected XmlCodec<?> binaryCodec(final BinaryTypeDefinition type) {
 111         return new QuotedXmlCodec<>(BinaryStringCodec.from(type));
 112     }
 113
 114     @Override
 115     protected XmlCodec<?> booleanCodec(final BooleanTypeDefinition type) {
 116         return new BooleanXmlCodec(BooleanStringCodec.from(type));
 117     }
 118
 119     @Override
 120     protected XmlCodec<?> bitsCodec(final BitsTypeDefinition type) {
 121         return new QuotedXmlCodec<>(BitsStringCodec.from(type));
 122     }
 123
 124     @Override
 125     protected XmlCodec<?> emptyCodec(final EmptyTypeDefinition type) {
 126         return EmptyXmlCodec.INSTANCE;
 127     }
 128
 129     @Override
 130     protected XmlCodec<?> enumCodec(final EnumTypeDefinition type) {
 131         return new QuotedXmlCodec<>(EnumStringCodec.from(type));
 132     }
 133
 134     @Override
 135     protected XmlCodec<?> identityRefCodec(final IdentityrefTypeDefinition type, final QNameModule module) {
 136         return new IdentityrefXmlCodec(getEffectiveModelContext(), module, pref);
 137     }
 138
 139     @Override
 140     protected XmlCodec<YangInstanceIdentifier> instanceIdentifierCodec(final InstanceIdentifierTypeDefinition type) {
 141         return instanceIdentifierCodec;
 142     }
 143
 144     @Override
 145     public XmlCodec<YangInstanceIdentifier> instanceIdentifierCodec() {
 146         return instanceIdentifierCodec;
 147     }
 148
 149     @Override
 150     protected XmlCodec<?> int8Codec(final Int8TypeDefinition type) {
 151         return new NumberXmlCodec<>(AbstractIntegerStringCodec.from(type));
 152     }
 153
 154     @Override
 155     protected XmlCodec<?> int16Codec(final Int16TypeDefinition type) {
 156         return new NumberXmlCodec<>(AbstractIntegerStringCodec.from(type));
 157     }
 158
 159     @Override
 160     protected XmlCodec<?> int32Codec(final Int32TypeDefinition type) {
 161         return new NumberXmlCodec<>(AbstractIntegerStringCodec.from(type));
 162     }
 163
 164     @Override
 165     protected XmlCodec<?> int64Codec(final Int64TypeDefinition type) {
 166         return new NumberXmlCodec<>(AbstractIntegerStringCodec.from(type));
 167     }
 168
 169     @Override
 170     protected XmlCodec<?> decimalCodec(final DecimalTypeDefinition type) {
 171         return new NumberXmlCodec<>(DecimalStringCodec.from(type));
 172     }
 173
 174     @Override
 175     protected XmlCodec<?> stringCodec(final StringTypeDefinition type) {
 176         // FIXME: YANGTOOLS-1523: use QuotedXmlCodec
 177         return new StringXmlCodec(StringStringCodec.from(type));
 178     }
 179
 180     @Override
 181     protected XmlCodec<?> uint8Codec(final Uint8TypeDefinition type) {
 182         return new NumberXmlCodec<>(AbstractIntegerStringCodec.from(type));
 183     }
 184
 185     @Override
 186     protected XmlCodec<?> uint16Codec(final Uint16TypeDefinition type) {
 187         return new NumberXmlCodec<>(AbstractIntegerStringCodec.from(type));
 188     }
 189
 190     @Override
 191     protected XmlCodec<?> uint32Codec(final Uint32TypeDefinition type) {
 192         return new NumberXmlCodec<>(AbstractIntegerStringCodec.from(type));
 193     }
 194
 195     @Override
 196     protected XmlCodec<?> uint64Codec(final Uint64TypeDefinition type) {
 197         return new NumberXmlCodec<>(AbstractIntegerStringCodec.from(type));
 198     }
 199
 200     @Override
 201     protected XmlCodec<?> unionCodec(final UnionTypeDefinition type, final List<XmlCodec<?>> codecs) {
 202         return UnionXmlCodec.create(type, codecs);
 203     }
 204
 205     @Override
 206     protected XmlCodec<?> unknownCodec(final UnknownTypeDefinition type) {
 207         return NullXmlCodec.INSTANCE;
 208     }
 209 }