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.yangtools.sal.java.api.generator;
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;
15 import javax.annotation.Nonnull;
16 import org.opendaylight.yangtools.sal.binding.model.api.ConcreteType;
17 import org.opendaylight.yangtools.sal.binding.model.api.Type;
18 import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint;
19 import org.slf4j.Logger;
20 import org.slf4j.LoggerFactory;
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;
26 private static void addGenerator(final Builder<String, AbstractRangeGenerator<?>> b, final AbstractRangeGenerator<?> generator) {
27 b.put(generator.getTypeClass().getCanonicalName(), generator);
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();
41 private final Class<T> type;
43 protected AbstractRangeGenerator(final Class<T> typeClass) {
44 this.type = Preconditions.checkNotNull(typeClass);
47 static AbstractRangeGenerator<?> forType(@Nonnull final Type type) {
48 final ConcreteType javaType = TypeUtils.getBaseYangType(type);
49 return GENERATORS.get(javaType.getFullyQualifiedName());
53 * Return the type's class.
55 * @return A class object
57 @Nonnull protected final Class<T> getTypeClass() {
62 * Return the type's fully-qualified name.
64 * @return Fully-qualified name
66 @Nonnull protected final String getTypeName() {
67 return type.getName();
71 * Return the value in the native type from a particular Number instance.
73 * @param value Value as a Number
74 * @return Value in native format.
76 @Nonnull protected final T getValue(final Number value) {
77 if (type.isInstance(value)) {
78 return type.cast(value);
81 LOG.debug("Converting value {} from {} to {}", value, value.getClass(), type);
82 final T ret = convert(value);
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);
94 // FIXME: Once BUG-3399 is fixed, we should never need this
96 protected abstract T convert(final Number value);
99 * Format a value into a Java-compilable expression which results in the appropriate
102 * @param value Number value
103 * @return Java language string representation
105 @Nonnull protected abstract String format(final T value);
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.
113 @Nonnull protected abstract String generateRangeCheckerImplementation(@Nonnull final String checkerName, @Nonnull final Collection<RangeConstraint> constraints);
115 private static String rangeCheckerName(final String member) {
116 return "check" + member + "Range";
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);
124 String generateRangeCheckerCall(@Nonnull final String member, @Nonnull final String valueReference) {
125 return rangeCheckerName(member) + '(' + valueReference + ");\n";