binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/java/api/generator/LengthGenerator.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.mdsal.binding.java.api.generator;
   9
  10 import com.google.common.collect.Range;
  11 import java.math.BigInteger;
  12 import java.util.ArrayList;
  13 import java.util.Collection;
  14 import java.util.List;
  15 import javax.annotation.Nonnull;
  16 import javax.annotation.Nullable;
  17 import org.opendaylight.mdsal.binding.model.api.Type;
  18 import org.opendaylight.yangtools.yang.model.api.type.LengthConstraint;
  19 import org.slf4j.Logger;
  20 import org.slf4j.LoggerFactory;
  21
  22 final class LengthGenerator {
  23     private static final Logger LOG = LoggerFactory.getLogger(LengthGenerator.class);
  24
  25     private LengthGenerator() {
  26         throw new UnsupportedOperationException();
  27     }
  28
  29     private static String lengthCheckerName(final String member) {
  30         return "check" + member + "Length";
  31     }
  32
  33     private static Collection<String> createExpressions(final Collection<LengthConstraint> constraints) {
  34         final Collection<String> ret = new ArrayList<>(constraints.size());
  35
  36         for (LengthConstraint l : constraints) {
  37             // We have to deal with restrictions being out of integer's range
  38             final long min = l.getMin().longValue();
  39             final long max = l.getMax().longValue();
  40
  41             if (min > 0 || max < Integer.MAX_VALUE) {
  42                 final StringBuilder sb = new StringBuilder("length >");
  43                 if (min <= Integer.MAX_VALUE) {
  44                     sb.append('=');
  45                 }
  46                 sb.append(' ').append(min);
  47
  48                 if (max < Integer.MAX_VALUE) {
  49                     sb.append(" && length <= ").append(max);
  50                 }
  51
  52                 ret.add(sb.toString());
  53             } else {
  54                 // This range is implicitly capped by String/byte[] length returns
  55                 LOG.debug("Constraint {} implied by int type value domain, skipping", l);
  56             }
  57         }
  58
  59         return ret;
  60     }
  61
  62     private static String createLengthString(final Collection<LengthConstraint> constraints) {
  63         final List<Range<BigInteger>> ranges = new ArrayList<>(constraints.size());
  64
  65         for (LengthConstraint c : constraints) {
  66             ranges.add(Range.closed(new BigInteger(c.getMin().toString()), new BigInteger(c.getMax().toString())));
  67         }
  68
  69         return ranges.toString();
  70     }
  71
  72     private static String generateArrayLengthChecker(final String member,
  73             final Collection<LengthConstraint> constraints) {
  74         final StringBuilder sb = new StringBuilder();
  75         final Collection<String> expressions = createExpressions(constraints);
  76
  77         sb.append("private static void ").append(lengthCheckerName(member)).append("(final byte[] value) {\n");
  78
  79         if (!expressions.isEmpty()) {
  80             sb.append("    final int length = value.length;\n");
  81
  82             for (String exp : expressions) {
  83                 sb.append("    if (").append(exp).append(") {\n");
  84                 sb.append("        return;\n");
  85                 sb.append("    }\n");
  86             }
  87
  88             sb.append("    throw new IllegalArgumentException(String.format(\"Invalid length: %s, expected: ")
  89               .append(createLengthString(constraints)).append(".\", java.util.Arrays.toString(value)));\n");
  90         }
  91
  92         sb.append("}\n");
  93
  94         return sb.toString();
  95     }
  96
  97     private static String generateStringLengthChecker(final String member,
  98             final Collection<LengthConstraint> constraints) {
  99         final StringBuilder sb = new StringBuilder();
 100         final Collection<String> expressions = createExpressions(constraints);
 101
 102         sb.append("private static void ").append(lengthCheckerName(member)).append("(final String value) {\n");
 103
 104         if (!expressions.isEmpty()) {
 105             sb.append("    final int length = value.length();\n");
 106
 107             for (String exp : expressions) {
 108                 sb.append("    if (").append(exp).append(") {\n");
 109                 sb.append("        return;\n");
 110                 sb.append("    }\n");
 111             }
 112
 113             sb.append("    throw new IllegalArgumentException(String.format(\"Invalid length: %s, expected: ")
 114               .append(createLengthString(constraints)).append(".\", value));\n");
 115         }
 116
 117         sb.append("}\n");
 118
 119         return sb.toString();
 120     }
 121
 122     static String generateLengthChecker(final String member, final Type type,
 123             final Collection<LengthConstraint> constraints) {
 124         return TypeUtils.getBaseYangType(type).getName().indexOf('[') != -1
 125                 ? generateArrayLengthChecker(member, constraints) : generateStringLengthChecker(member, constraints);
 126     }
 127
 128     static String generateLengthCheckerCall(@Nullable final String member, @Nonnull final String valueReference) {
 129         return lengthCheckerName(member) + '(' + valueReference + ");\n";
 130     }
 131 }