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