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