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 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 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 Map<String, AbstractRangeGenerator<?>> GENERATORS;
  26
  27     private static void addGenerator(final Builder<String, AbstractRangeGenerator<?>> b,
  28             final AbstractRangeGenerator<?> generator) {
  29         b.put(generator.getTypeClass().getCanonicalName(), generator);
  30     }
  31
  32     static {
  33         final Builder<String, AbstractRangeGenerator<?>> b = ImmutableMap.<String, AbstractRangeGenerator<?>> 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         GENERATORS = b.build();
  41     }
  42
  43     private final Class<T> type;
  44
  45     protected AbstractRangeGenerator(final Class<T> typeClass) {
  46         this.type = requireNonNull(typeClass);
  47     }
  48
  49     static AbstractRangeGenerator<?> forType(final @NonNull Type type) {
  50         final ConcreteType javaType = TypeUtils.getBaseYangType(type);
  51         return GENERATORS.get(javaType.getFullyQualifiedName());
  52     }
  53
  54     /**
  55      * Return the type's class.
  56      *
  57      * @return A class object
  58      */
  59     protected final @NonNull Class<T> getTypeClass() {
  60         return type;
  61     }
  62
  63     /**
  64      * Return the type's fully-qualified name.
  65      *
  66      * @return Fully-qualified name
  67      */
  68     protected final @NonNull String getTypeName() {
  69         return type.getName();
  70     }
  71
  72     /**
  73      * Return the value in the native type from a particular Number instance.
  74      *
  75      * @param value Value as a Number
  76      * @return Value in native format.
  77      */
  78     protected final @NonNull T getValue(final Number value) {
  79         if (type.isInstance(value)) {
  80             return type.cast(value);
  81         }
  82
  83         LOG.debug("Converting value {} from {} to {}", value, value.getClass(), type);
  84         final T ret = convert(value);
  85
  86         // Check if the conversion lost any precision by performing conversion the other way around
  87         final AbstractRangeGenerator<?> gen = GENERATORS.get(value.getClass().getName());
  88         final Number check = gen.convert(ret);
  89         if (!value.equals(check)) {
  90             LOG.warn("Number class conversion from {} to {} truncated value {} to {}", value.getClass(), type, value,
  91                 ret);
  92         }
  93
  94         return ret;
  95     }
  96
  97     // FIXME: Once BUG-3399 is fixed, we should never need this
  98     @Deprecated
  99     protected abstract T convert(Number value);
 100
 101     /**
 102      * Format a value into a Java-compilable expression which results in the appropriate
 103      * type.
 104      *
 105      * @param value Number value
 106      * @return Java language string representation
 107      */
 108     protected abstract @NonNull String format(T value);
 109
 110     /**
 111      * Generate the checker method source code.
 112      * @param checkerName Name of the checker method.
 113      * @param constraints Restrictions which need to be applied.
 114      * @return Method source code.
 115      */
 116     protected abstract @NonNull String generateRangeCheckerImplementation(@NonNull String checkerName,
 117             @NonNull RangeConstraint<?> constraints, Function<Class<?>, String> classImporter);
 118
 119     private static String rangeCheckerName(final String member) {
 120         return "check" + member + "Range";
 121     }
 122
 123     String generateRangeChecker(final @NonNull String member, final @NonNull RangeConstraint<?> constraints,
 124             final JavaFileTemplate template) {
 125         return generateRangeCheckerImplementation(rangeCheckerName(member), constraints, template::importedName);
 126     }
 127
 128     String generateRangeCheckerCall(final @NonNull String member, final @NonNull String valueReference) {
 129         return rangeCheckerName(member) + '(' + valueReference + ");\n";
 130     }
 131 }