binding2/mdsal-binding2-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/javav2/java/api/generator/range_generators/AbstractPrimitiveRangeGenerator.java

   1 /*
   2  * Copyright (c) 2017 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.javav2.java.api.generator.range_generators;
   9
  10 import com.google.common.base.Preconditions;
  11 import com.google.common.collect.Range;
  12 import java.util.ArrayList;
  13 import java.util.Collection;
  14 import java.util.Set;
  15 import javax.annotation.Nonnull;
  16 import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint;
  17 import org.slf4j.Logger;
  18 import org.slf4j.LoggerFactory;
  19
  20 abstract class AbstractPrimitiveRangeGenerator<T extends Number & Comparable<T>> extends AbstractRangeGenerator<T> {
  21     private static final Logger LOG = LoggerFactory.getLogger(AbstractPrimitiveRangeGenerator.class);
  22     private final String primitiveName;
  23     private final T minValue;
  24     private final T maxValue;
  25
  26     protected AbstractPrimitiveRangeGenerator(final Class<T> typeClass, final String primitiveName, final T minValue,
  27             final T maxValue) {
  28         super(typeClass);
  29         this.primitiveName = Preconditions.checkNotNull(primitiveName);
  30         this.minValue = Preconditions.checkNotNull(minValue);
  31         this.maxValue = Preconditions.checkNotNull(maxValue);
  32     }
  33
  34     /**
  35      * Return the name of the primitive type, as known by the Java language.
  36      *
  37      * @return Primitive type name
  38      */
  39     @Nonnull protected final String getPrimitiveName() {
  40         return primitiveName;
  41     }
  42
  43     private boolean needsMaximumEnforcement(final T maxToEnforce) {
  44         return maxValue.compareTo(maxToEnforce) > 0;
  45     }
  46
  47     private boolean needsMinimumEnforcement(final T minToEnforce) {
  48         return minValue.compareTo(minToEnforce) < 0;
  49     }
  50
  51     /**
  52      * Format a value into a Java-compilable 'greater equal' compare expression.
  53      * The method would be overrided by {@link AbstractUnsignedIntegerRangeGenerator}.
  54      *
  55      * @param value Number value
  56      * @return Java language compare string representation
  57      */
  58     @Nonnull protected String gtExpression(T value) {
  59         return "value >= " + format(value);
  60     }
  61
  62     /**
  63      * Format a value into a Java-compilable 'less equal' compare expression.
  64      * The method would be overrided by {@link AbstractUnsignedIntegerRangeGenerator}.
  65      *
  66      * @param value Number value
  67      * @return Java language compare string representation
  68      */
  69     @Nonnull protected String ltExpression(T value) {
  70         return "value <= " + format(value);
  71     }
  72
  73     private Collection<String> createExpressions(final RangeConstraint<?> constraint) {
  74         final Set<? extends Range<? extends Number>> constraints = constraint.getAllowedRanges().asRanges();
  75         final Collection<String> ret = new ArrayList<>(constraints.size());
  76
  77         for (Range<? extends Number> r : constraints) {
  78             final T min = getValue(r.lowerEndpoint());
  79             final boolean needMin = needsMinimumEnforcement(min);
  80
  81             final T max = getValue(r.upperEndpoint());
  82             final boolean needMax = needsMaximumEnforcement(max);
  83
  84             if (!needMin && !needMax) {
  85                 LOG.debug("Type {} indicates [{}, {}] does not require enforcement", getTypeName(), min, max);
  86                 continue;
  87             }
  88
  89             final StringBuilder sb = new StringBuilder();
  90             if (needMin) {
  91                 sb.append(gtExpression(min));
  92             }
  93             if (needMax) {
  94                 if (needMin) {
  95                     sb.append(" && ");
  96                 }
  97                 sb.append(ltExpression(max));
  98             }
  99
 100             ret.add(sb.toString());
 101         }
 102
 103         return ret;
 104     }
 105
 106     private static String createRangeString(final RangeConstraint<?> constraints) {
 107         return constraints.getAllowedRanges().toString();
 108     }
 109
 110     @Override
 111     protected final String generateRangeCheckerImplementation(final String checkerName,
 112             final RangeConstraint<?> constraint) {
 113         final StringBuilder sb = new StringBuilder();
 114         final Collection<String> expressions = createExpressions(constraint);
 115
 116         sb.append("private static void ").append(checkerName).append("(final ").append(primitiveName)
 117             .append(" value) {\n");
 118
 119         if (!expressions.isEmpty()) {
 120             for (String exp : expressions) {
 121                 sb.append("    if (").append(exp).append(") {\n");
 122                 sb.append("        return;\n");
 123                 sb.append("    }\n");
 124             }
 125
 126             sb.append("    throw new IllegalArgumentException(String.format(\"Invalid range: %s, expected: ")
 127               .append(createRangeString(constraint)).append(".\", value));\n");
 128         }
 129
 130         sb.append("}\n");
 131
 132         return sb.toString();
 133     }
 134 }