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