code-generator/binding-java-api-generator/src/main/java/org/opendaylight/yangtools/sal/java/api/generator/AbstractPrimitiveRangeGenerator.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.yangtools.sal.java.api.generator;
   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.List;
  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     private Collection<String> createExpressions(final Collection<RangeConstraint> constraints) {
  51         final Collection<String> ret = new ArrayList<>(constraints.size());
  52
  53         for (RangeConstraint r : constraints) {
  54             final T min = getValue(r.getMin());
  55             final boolean needMin = needsMinimumEnforcement(min);
  56
  57             final T max = getValue(r.getMax());
  58             final boolean needMax = needsMaximumEnforcement(max);
  59
  60             if (!needMin && !needMax) {
  61                 LOG.debug("Type {} indicates [{}, {}] does not require enforcement", getTypeName(), min, max);
  62                 continue;
  63             }
  64
  65             final StringBuilder sb = new StringBuilder();
  66             if (needMin) {
  67                 sb.append("value >= ").append(format(min));
  68             }
  69             if (needMax) {
  70                 if (needMin) {
  71                     sb.append(" && ");
  72                 }
  73                 sb.append("value <= ").append(format(max));
  74             }
  75
  76             ret.add(sb.toString());
  77         }
  78
  79         return ret;
  80     }
  81
  82     private String createRangeString(final Collection<RangeConstraint> constraints) {
  83         final List<Range<T>> ranges = new ArrayList<>(constraints.size());
  84
  85         for (RangeConstraint c : constraints) {
  86             ranges.add(Range.closed(getValue(c.getMin()), getValue(c.getMax())));
  87         }
  88
  89         return ranges.toString();
  90     }
  91
  92     @Override
  93     protected final String generateRangeCheckerImplementation(final String checkerName, final Collection<RangeConstraint> constraints) {
  94         final StringBuilder sb = new StringBuilder();
  95         final Collection<String> expressions = createExpressions(constraints);
  96
  97         sb.append("private static void ").append(checkerName).append("(final ").append(primitiveName).append(" value) {\n");
  98
  99         if (!expressions.isEmpty()) {
 100             for (String exp : expressions) {
 101                 sb.append("    if (").append(exp).append(") {\n");
 102                 sb.append("        return;\n");
 103                 sb.append("    }\n");
 104             }
 105
 106             sb.append("    throw new IllegalArgumentException(String.format(\"Invalid range: %s, expected: ")
 107               .append(createRangeString(constraints)).append(".\", value));\n");
 108         }
 109
 110         sb.append("}\n");
 111
 112         return sb.toString();
 113     }
 114 }