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.util.ArrayList;
  12 import java.util.Collection;
  13 import java.util.Set;
  14 import javax.annotation.Nonnull;
  15 import javax.annotation.Nullable;
  16 import org.opendaylight.mdsal.binding.model.api.Type;
  17 import org.opendaylight.yangtools.yang.model.api.type.LengthConstraint;
  18 import org.slf4j.Logger;
  19 import org.slf4j.LoggerFactory;
  20
  21 final class LengthGenerator {
  22     private static final Logger LOG = LoggerFactory.getLogger(LengthGenerator.class);
  23
  24     private LengthGenerator() {
  25         throw new UnsupportedOperationException();
  26     }
  27
  28     private static String lengthCheckerName(final String member) {
  29         return "check" + member + "Length";
  30     }
  31
  32     private static Collection<String> createExpressions(final LengthConstraint constraint) {
  33         final Set<Range<Integer>> constraints = constraint.getAllowedRanges().asRanges();
  34         final Collection<String> ret = new ArrayList<>(constraints.size());
  35
  36         for (Range<Integer> l : constraints) {
  37             // We have to deal with restrictions being out of integer's range
  38             final int min = l.lowerEndpoint().intValue();
  39             final int max = l.upperEndpoint().intValue();
  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 LengthConstraint constraint) {
  63         return new ArrayList<>(constraint.getAllowedRanges().asRanges()).toString();
  64     }
  65
  66     private static String generateArrayLengthChecker(final String member, final LengthConstraint constraint) {
  67         final StringBuilder sb = new StringBuilder();
  68         final Collection<String> expressions = createExpressions(constraint);
  69
  70         sb.append("private static void ").append(lengthCheckerName(member)).append("(final byte[] value) {\n");
  71
  72         if (!expressions.isEmpty()) {
  73             sb.append("    final int length = value.length;\n");
  74
  75             for (String exp : expressions) {
  76                 sb.append("    if (").append(exp).append(") {\n");
  77                 sb.append("        return;\n");
  78                 sb.append("    }\n");
  79             }
  80
  81             sb.append("    throw new IllegalArgumentException(String.format(\"Invalid length: %s, expected: ")
  82               .append(createLengthString(constraint)).append(".\", java.util.Arrays.toString(value)));\n");
  83         }
  84
  85         sb.append("}\n");
  86
  87         return sb.toString();
  88     }
  89
  90     private static String generateStringLengthChecker(final String member, final LengthConstraint constraint) {
  91         final StringBuilder sb = new StringBuilder();
  92         final Collection<String> expressions = createExpressions(constraint);
  93
  94         sb.append("private static void ").append(lengthCheckerName(member)).append("(final String value) {\n");
  95
  96         if (!expressions.isEmpty()) {
  97             sb.append("    final int length = value.length();\n");
  98
  99             for (String exp : expressions) {
 100                 sb.append("    if (").append(exp).append(") {\n");
 101                 sb.append("        return;\n");
 102                 sb.append("    }\n");
 103             }
 104
 105             sb.append("    throw new IllegalArgumentException(String.format(\"Invalid length: %s, expected: ")
 106               .append(createLengthString(constraint)).append(".\", value));\n");
 107         }
 108
 109         sb.append("}\n");
 110
 111         return sb.toString();
 112     }
 113
 114     static String generateLengthChecker(final String member, final Type type,
 115             final LengthConstraint constraint) {
 116         return TypeUtils.getBaseYangType(type).getName().indexOf('[') != -1
 117                 ? generateArrayLengthChecker(member, constraint) : generateStringLengthChecker(member, constraint);
 118     }
 119
 120     static String generateLengthCheckerCall(@Nullable final String member, @Nonnull final String valueReference) {
 121         return lengthCheckerName(member) + '(' + valueReference + ");\n";
 122     }
 123 }