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