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 org.eclipse.jdt.annotation.NonNull;
  15 import org.eclipse.jdt.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 String expr = createExpression(l.lowerEndpoint().intValue(), l.upperEndpoint().intValue());
  39             if (expr == null) {
  40                 // This range is implicitly capped by String/byte[] length returns
  41                 LOG.debug("Constraint {} implied by int type value domain, skipping", l);
  42             } else {
  43                 ret.add(expr);
  44             }
  45         }
  46
  47         return ret;
  48     }
  49
  50     private static @Nullable String createExpression(final int min, final int max) {
  51         if (min == max) {
  52             return min < Integer.MAX_VALUE ? "length == " + min : null;
  53         }
  54         if (min > 0) {
  55             final StringBuilder sb = new StringBuilder("length >= ").append(min);
  56             if (max < Integer.MAX_VALUE) {
  57                 sb.append(" && length <= ").append(max);
  58             }
  59             return sb.toString();
  60         }
  61
  62         return max < Integer.MAX_VALUE ? "length <= " + max : null;
  63     }
  64
  65     private static String createLengthString(final LengthConstraint constraint) {
  66         return new ArrayList<>(constraint.getAllowedRanges().asRanges()).toString();
  67     }
  68
  69     private static String generateArrayLengthChecker(final String member, final LengthConstraint constraint,
  70             final JavaFileTemplate template) {
  71         final StringBuilder sb = new StringBuilder();
  72         final Collection<String> expressions = createExpressions(constraint);
  73
  74         sb.append("private static void ").append(lengthCheckerName(member)).append("(final byte[] value) {\n");
  75
  76         if (!expressions.isEmpty()) {
  77             sb.append("    final int length = value.length;\n");
  78
  79             for (String exp : expressions) {
  80                 sb.append("    if (").append(exp).append(") {\n");
  81                 sb.append("        return;\n");
  82                 sb.append("    }\n");
  83             }
  84
  85             sb.append("    ").append(template.importedName(JavaFileTemplate.CODEHELPERS))
  86             .append(".throwInvalidLength(\"").append(createLengthString(constraint)).append("\", value);\n");
  87         }
  88
  89         return sb.append("}\n").toString();
  90     }
  91
  92     private static String generateStringLengthChecker(final String member, final LengthConstraint constraint,
  93             final JavaFileTemplate template) {
  94         final StringBuilder sb = new StringBuilder();
  95         final Collection<String> expressions = createExpressions(constraint);
  96
  97         sb.append("private static void ").append(lengthCheckerName(member)).append("(final String value) {\n");
  98
  99         if (!expressions.isEmpty()) {
 100             sb.append("    final int length = value.length();\n");
 101
 102             for (String exp : expressions) {
 103                 sb.append("    if (").append(exp).append(") {\n");
 104                 sb.append("        return;\n");
 105                 sb.append("    }\n");
 106             }
 107
 108             sb.append("    ").append(template.importedName(JavaFileTemplate.CODEHELPERS))
 109             .append(".throwInvalidLength(\"").append(createLengthString(constraint)).append("\", value);\n");
 110         }
 111
 112         return sb.append("}\n").toString();
 113     }
 114
 115     static String generateLengthChecker(final String member, final @NonNull Type type,
 116             final LengthConstraint constraint, final JavaFileTemplate template) {
 117         return TypeUtils.getBaseYangType(type).getName().indexOf('[') != -1
 118                 ? generateArrayLengthChecker(member, constraint, template)
 119                         : generateStringLengthChecker(member, constraint, template);
 120     }
 121
 122     static String generateLengthCheckerCall(final @Nullable String member, final @NonNull String valueReference) {
 123         return lengthCheckerName(member) + '(' + valueReference + ");\n";
 124     }
 125 }