2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.mdsal.binding.java.api.generator;
10 import static com.google.common.base.Verify.verifyNotNull;
11 import static java.util.Objects.requireNonNull;
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;
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;
27 private static void addGenerator(final Builder<String, AbstractRangeGenerator<?>> builder,
28 final AbstractRangeGenerator<?> generator) {
29 builder.put(generator.getTypeClass().getCanonicalName(), generator);
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 GENERATORS = b.build();
43 private final Class<T> type;
45 protected AbstractRangeGenerator(final Class<T> typeClass) {
46 this.type = requireNonNull(typeClass);
49 static @NonNull AbstractRangeGenerator<?> forType(final @NonNull Type type) {
50 final ConcreteType javaType = TypeUtils.getBaseYangType(type);
51 return forName(javaType.getFullyQualifiedName());
54 private static @NonNull AbstractRangeGenerator<?> forName(final String fqcn) {
55 return verifyNotNull(GENERATORS.get(fqcn), "Unhandled type %s", fqcn);
59 * Return the type's class.
61 * @return A class object
63 protected final @NonNull Class<T> getTypeClass() {
68 * Return the type's fully-qualified name.
70 * @return Fully-qualified name
72 protected final @NonNull String getTypeName() {
73 return type.getName();
77 * Return the value in the native type from a particular Number instance.
79 * @param value Value as a Number
80 * @return Value in native format.
82 protected final @NonNull T getValue(final Number value) {
83 if (type.isInstance(value)) {
84 return type.cast(value);
87 LOG.debug("Converting value {} from {} to {}", value, value.getClass(), type);
88 final T ret = convert(value);
90 // Check if the conversion lost any precision by performing conversion the other way around
91 final AbstractRangeGenerator<?> gen = forName(value.getClass().getName());
92 final Number check = gen.convert(ret);
93 if (!value.equals(check)) {
94 LOG.warn("Number class conversion from {} to {} truncated value {} to {}", value.getClass(), type, value,
101 // FIXME: Once BUG-3399 is fixed, we should never need this
103 protected abstract T convert(Number value);
106 * Format a value into a Java-compilable expression which results in the appropriate
109 * @param value Number value
110 * @return Java language string representation
112 protected abstract @NonNull String format(T value);
115 * Generate the checker method source code.
116 * @param checkerName Name of the checker method.
117 * @param constraints Restrictions which need to be applied.
118 * @return Method source code.
120 protected abstract @NonNull String generateRangeCheckerImplementation(@NonNull String checkerName,
121 @NonNull RangeConstraint<?> constraints, Function<Class<?>, String> classImporter);
123 private static String rangeCheckerName(final String member) {
124 return "check" + member + "Range";
127 String generateRangeChecker(final @NonNull String member, final @NonNull RangeConstraint<?> constraints,
128 final JavaFileTemplate template) {
129 return generateRangeCheckerImplementation(rangeCheckerName(member), constraints, template::importedName);
132 String generateRangeCheckerCall(final @NonNull String member, final @NonNull String valueReference) {
133 return rangeCheckerName(member) + '(' + valueReference + ");\n";