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