code-generator/binding-java-api-generator/src/main/java/org/opendaylight/yangtools/sal/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.yangtools.sal.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 javax.annotation.Nullable;
  17 import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint;
  18 import org.slf4j.Logger;
  19 import org.slf4j.LoggerFactory;
  20
  21 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<?>> b, final AbstractRangeGenerator<?> generator) {
  26         b.put(generator.getTypeClass().getCanonicalName(), generator);
  27     }
  28
  29     static {
  30         final Builder<String, AbstractRangeGenerator<?>> b = ImmutableMap.<String, AbstractRangeGenerator<?>> builder();
  31         addGenerator(b, new ByteRangeGenerator());
  32         addGenerator(b, new ShortRangeGenerator());
  33         addGenerator(b, new IntegerRangeGenerator());
  34         addGenerator(b, new LongRangeGenerator());
  35         addGenerator(b, new BigDecimalRangeGenerator());
  36         addGenerator(b, new BigIntegerRangeGenerator());
  37         GENERATORS = b.build();
  38     }
  39
  40     private final Class<T> type;
  41
  42     protected AbstractRangeGenerator(final Class<T> typeClass) {
  43         this.type = Preconditions.checkNotNull(typeClass);
  44     }
  45
  46     static AbstractRangeGenerator<?> getInstance(final String canonicalName) {
  47         return GENERATORS.get(canonicalName);
  48     }
  49
  50     /**
  51      * Return the type's class.
  52      *
  53      * @return A class object
  54      */
  55     protected final @Nonnull Class<T> getTypeClass() {
  56         return type;
  57     }
  58
  59     /**
  60      * Return the type's fully-qualified name.
  61      *
  62      * @return Fully-qualified name
  63      */
  64     protected final @Nonnull String getTypeName() {
  65         return type.getName();
  66     }
  67
  68     protected final @Nonnull T getValue(final Number value) {
  69         if (type.isInstance(value)) {
  70             return type.cast(value);
  71         }
  72
  73         LOG.info("Number class conversion from {} to {} may lose precision of {}", value.getClass(), type, value);
  74         return convert(value);
  75     }
  76
  77     // FIXME: Once BUG-3399 is fixed, we should never need this
  78     @Deprecated
  79     protected abstract T convert(final Number value);
  80
  81     /**
  82      * Format a value into a Java-compilable expression which results in the appropriate
  83      * type.
  84      * @param number Number value
  85      * @return Java language string representation
  86      */
  87     protected abstract @Nonnull String format(final T number);
  88
  89     /**
  90      * Generate the checker method source code.
  91      * @param checkerName Name of the checker method.
  92      * @param restrictions Restrictions which need to be applied.
  93      * @return Method source code.
  94      */
  95     protected abstract @Nonnull String generateRangeCheckerImplementation(@Nonnull final String checkerName, @Nonnull final Collection<RangeConstraint> restrictions);
  96
  97     private static String rangeCheckerName(final String member) {
  98         final StringBuilder sb = new StringBuilder("check");
  99         if (member != null) {
 100             sb.append(member);
 101         }
 102         return sb.append("Range").toString();
 103     }
 104
 105     String generateRangeChecker(@Nullable final String member, @Nonnull final Collection<RangeConstraint> restrictions) {
 106         Preconditions.checkArgument(!restrictions.isEmpty(), "Restrictions may not be empty");
 107         return generateRangeCheckerImplementation(rangeCheckerName(member), restrictions);
 108     }
 109
 110     String generateRangeCheckerCall(@Nullable final String member, @Nonnull final String valueReference) {
 111         return rangeCheckerName(member) + '(' + valueReference + ");\n";
 112     }
 113 }