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