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.binding.CodeHelpers;
  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 LengthConstraint constraint) {
  34         final Set<Range<Integer>> constraints = constraint.getAllowedRanges().asRanges();
  35         final Collection<String> ret = new ArrayList<>(constraints.size());
  36
  37         for (Range<Integer> l : constraints) {
  38             // We have to deal with restrictions being out of integer's range
  39             final int min = l.lowerEndpoint().intValue();
  40             final int max = l.upperEndpoint().intValue();
  41
  42             if (min > 0 || max < Integer.MAX_VALUE) {
  43                 final StringBuilder sb = new StringBuilder().append("length ");
  44                 if (min != max) {
  45                     sb.append('>');
  46                     if (min <= Integer.MAX_VALUE) {
  47                         sb.append('=');
  48                     }
  49                     sb.append(' ').append(min);
  50
  51                     if (max < Integer.MAX_VALUE) {
  52                         sb.append(" && length <= ").append(max);
  53                     }
  54                 } else {
  55                     // Single-value, use a direct comparison
  56                     sb.append("== ").append(min);
  57                 }
  58                 ret.add(sb.toString());
  59             } else {
  60                 // This range is implicitly capped by String/byte[] length returns
  61                 LOG.debug("Constraint {} implied by int type value domain, skipping", l);
  62             }
  63         }
  64
  65         return ret;
  66     }
  67
  68     private static String createLengthString(final LengthConstraint constraint) {
  69         return new ArrayList<>(constraint.getAllowedRanges().asRanges()).toString();
  70     }
  71
  72     private static String generateArrayLengthChecker(final String member, final LengthConstraint constraint,
  73             final JavaFileTemplate template) {
  74         final StringBuilder sb = new StringBuilder();
  75         final Collection<String> expressions = createExpressions(constraint);
  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("    ").append(template.importedName(CodeHelpers.class)).append(".throwInvalidLength(\"")
  89             .append(createLengthString(constraint)).append("\", value);\n");
  90         }
  91
  92         return sb.append("}\n").toString();
  93     }
  94
  95     private static String generateStringLengthChecker(final String member, final LengthConstraint constraint,
  96             final JavaFileTemplate template) {
  97         final StringBuilder sb = new StringBuilder();
  98         final Collection<String> expressions = createExpressions(constraint);
  99
 100         sb.append("private static void ").append(lengthCheckerName(member)).append("(final String value) {\n");
 101
 102         if (!expressions.isEmpty()) {
 103             sb.append("    final int length = value.length();\n");
 104
 105             for (String exp : expressions) {
 106                 sb.append("    if (").append(exp).append(") {\n");
 107                 sb.append("        return;\n");
 108                 sb.append("    }\n");
 109             }
 110
 111             sb.append("    ").append(template.importedName(CodeHelpers.class)).append(".throwInvalidLength(\"")
 112             .append(createLengthString(constraint)).append("\", value);\n");
 113         }
 114
 115         return sb.append("}\n").toString();
 116     }
 117
 118     static String generateLengthChecker(final String member, final Type type,
 119             final LengthConstraint constraint, final JavaFileTemplate template) {
 120         return TypeUtils.getBaseYangType(type).getName().indexOf('[') != -1
 121                 ? generateArrayLengthChecker(member, constraint, template)
 122                         : generateStringLengthChecker(member, constraint, template);
 123     }
 124
 125     static String generateLengthCheckerCall(final @Nullable String member, final @NonNull String valueReference) {
 126         return lengthCheckerName(member) + '(' + valueReference + ");\n";
 127     }
 128 }