binding2/mdsal-binding2-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/javav2/java/api/generator/range_generators/AbstractRangeGenerator.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 static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.collect.ImmutableMap;
  13 import com.google.common.collect.ImmutableMap.Builder;
  14 import java.util.Map;
  15 import javax.annotation.Nonnull;
  16 import org.opendaylight.mdsal.binding.javav2.model.api.ConcreteType;
  17 import org.opendaylight.mdsal.binding.javav2.model.api.Type;
  18 import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint;
  19 import org.slf4j.Logger;
  20 import org.slf4j.LoggerFactory;
  21
  22 public abstract class AbstractRangeGenerator<T extends Number & Comparable<T>> {
  23     private static final Logger LOG = LoggerFactory.getLogger(AbstractRangeGenerator.class);
  24     private static final Map<String, AbstractRangeGenerator<?>> GENERATORS;
  25
  26     private static void addGenerator(final Builder<String, AbstractRangeGenerator<?>> builder,
  27             final AbstractRangeGenerator<?> generator) {
  28         builder.put(generator.getTypeClass().getCanonicalName(), generator);
  29     }
  30
  31     static {
  32         final Builder<String, AbstractRangeGenerator<?>> b = ImmutableMap.builder();
  33         addGenerator(b, new ByteRangeGenerator());
  34         addGenerator(b, new ShortRangeGenerator());
  35         addGenerator(b, new IntegerRangeGenerator());
  36         addGenerator(b, new LongRangeGenerator());
  37         addGenerator(b, new Uint8RangeGenerator());
  38         addGenerator(b, new Uint16RangeGenerator());
  39         addGenerator(b, new Uint32RangeGenerator());
  40         addGenerator(b, new Uint64RangeGenerator());
  41         addGenerator(b, new BigDecimalRangeGenerator());
  42         addGenerator(b, new BigIntegerRangeGenerator());
  43         GENERATORS = b.build();
  44     }
  45
  46     private final Class<T> type;
  47
  48     protected AbstractRangeGenerator(final Class<T> typeClass) {
  49         this.type = requireNonNull(typeClass);
  50     }
  51
  52     public static AbstractRangeGenerator<?> forType(@Nonnull final Type type) {
  53         final ConcreteType javaType = TypeUtils.getBaseYangType(type);
  54         return GENERATORS.get(javaType.getFullyQualifiedName());
  55     }
  56
  57     /**
  58      * Return the type's class.
  59      *
  60      * @return A class object
  61      */
  62     @Nonnull protected final Class<T> getTypeClass() {
  63         return type;
  64     }
  65
  66     /**
  67      * Return the type's fully-qualified name.
  68      *
  69      * @return Fully-qualified name
  70      */
  71     @Nonnull protected final String getTypeName() {
  72         return type.getName();
  73     }
  74
  75     /**
  76      * Return the value in the native type from a particular Number instance.
  77      *
  78      * @param value Value as a Number
  79      * @return Value in native format.
  80      */
  81     @Nonnull protected final T getValue(final Number value) {
  82         if (type.isInstance(value)) {
  83             return type.cast(value);
  84         }
  85
  86         LOG.debug("Converting value {} from {} to {}", value, value.getClass(), type);
  87         final T ret = convert(value);
  88
  89         // Check if the conversion lost any precision by performing conversion the other way around
  90         final AbstractRangeGenerator<?> gen = GENERATORS.get(value.getClass().getName());
  91         final Number check = gen.convert(ret);
  92         if (!value.equals(check)) {
  93             LOG.warn("Number class conversion from {} to {} truncated value {} to {}", value.getClass(),
  94                 type, value, ret);
  95         }
  96
  97         return ret;
  98     }
  99
 100     // FIXME: Once BUG-3399 is fixed, we should never need this
 101     protected abstract T convert(Number value);
 102
 103     /**
 104      * Format a value into a Java-compilable expression which results in the appropriate
 105      * type.
 106      *
 107      * @param value Number value
 108      * @return Java language string representation
 109      */
 110     @Nonnull protected abstract String format(T value);
 111
 112     /**
 113      * Generate the checker method source code.
 114      * @param checkerName Name of the checker method.
 115      * @param constraint Restrictions which need to be applied.
 116      * @return Method source code.
 117      */
 118     @Nonnull protected abstract String generateRangeCheckerImplementation(@Nonnull String checkerName,
 119             @Nonnull RangeConstraint<?> constraint);
 120
 121     private static String rangeCheckerName(final String member) {
 122         return "check" + member + "Range";
 123     }
 124
 125     public String generateRangeChecker(@Nonnull final String member, @Nonnull final RangeConstraint<?> constraint) {
 126         return generateRangeCheckerImplementation(rangeCheckerName(member), constraint);
 127     }
 128
 129     public String generateRangeCheckerCall(@Nonnull final String member, @Nonnull final String valueReference) {
 130         return rangeCheckerName(member) + '(' + valueReference + ");\n";
 131     }
 132 }