data/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/codec/BitsStringCodec.java

   1 /*
   2  * Copyright (c) 2015 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.impl.codec;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.annotations.Beta;
  14 import com.google.common.base.Joiner;
  15 import com.google.common.base.Splitter;
  16 import com.google.common.collect.Collections2;
  17 import com.google.common.collect.ImmutableSet;
  18 import java.util.ArrayList;
  19 import java.util.List;
  20 import java.util.Set;
  21 import org.eclipse.jdt.annotation.NonNull;
  22 import org.opendaylight.yangtools.yang.data.api.codec.BitsCodec;
  23 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
  24 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition.Bit;
  25
  26 /**
  27  * Do not use this class outside of yangtools, its presence does not fall into the API stability contract.
  28  */
  29 @Beta
  30 public final class BitsStringCodec extends TypeDefinitionAwareCodec<Set<String>, BitsTypeDefinition>
  31         implements BitsCodec<String> {
  32
  33     private static final Joiner JOINER = Joiner.on(" ").skipNulls();
  34     private static final Splitter SPLITTER = Splitter.on(' ').omitEmptyStrings().trimResults();
  35
  36     private final ImmutableSet<String> validBits;
  37
  38     @SuppressWarnings("unchecked")
  39     private BitsStringCodec(final @NonNull BitsTypeDefinition typeDef) {
  40         super(typeDef, (Class<Set<String>>) (Class<?>) Set.class);
  41         validBits = ImmutableSet.copyOf(Collections2.transform(typeDef.getBits(), Bit::getName));
  42     }
  43
  44     public static BitsStringCodec from(final BitsTypeDefinition type) {
  45         return new BitsStringCodec(requireNonNull(type));
  46     }
  47
  48     @Override
  49     protected Set<String> deserializeImpl(final String product) {
  50         final Set<String> strings = ImmutableSet.copyOf(SPLITTER.split(product));
  51
  52         // Normalize strings to schema first, retaining definition order
  53         final List<String> sorted = new ArrayList<>(strings.size());
  54         for (final String bit : validBits) {
  55             if (strings.contains(bit)) {
  56                 sorted.add(bit);
  57             }
  58         }
  59
  60         // Check sizes, if the normalized set does not match non-normalized size, non-normalized strings contain
  61         // an invalid bit.
  62         if (sorted.size() != strings.size()) {
  63             for (final String bit : strings) {
  64                 checkArgument(validBits.contains(bit), "Invalid value '%s' for bits type. Allowed values are: %s", bit,
  65                     validBits);
  66             }
  67         }
  68
  69         // In case all valid bits have been specified, retain the set we have created for this codec
  70         return sorted.size() == validBits.size() ? validBits : ImmutableSet.copyOf(sorted);
  71     }
  72
  73     @Override
  74     protected String serializeImpl(final Set<String> input) {
  75         return JOINER.join(input);
  76     }
  77 }