2 * Copyright (c) 2015 Pantheon Technologies s.r.o. 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.yang.model.util.type;
10 import com.google.common.base.Optional;
11 import com.google.common.base.Preconditions;
12 import com.google.common.base.Verify;
13 import com.google.common.collect.ImmutableList;
14 import com.google.common.collect.ImmutableList.Builder;
15 import java.util.Collection;
16 import java.util.List;
17 import java.util.function.Function;
18 import javax.annotation.Nonnull;
19 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
20 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
21 import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint;
22 import org.opendaylight.yangtools.yang.model.util.BaseConstraints;
23 import org.opendaylight.yangtools.yang.model.util.UnresolvedNumber;
25 public abstract class RangeRestrictedTypeBuilder<T extends TypeDefinition<T>> extends AbstractRestrictedTypeBuilder<T> {
26 private List<RangeConstraint> rangeAlternatives;
28 RangeRestrictedTypeBuilder(final T baseType, final SchemaPath path) {
29 super(baseType, path);
32 public final void setRangeAlternatives(@Nonnull final Collection<RangeConstraint> rangeAlternatives) {
33 Preconditions.checkState(this.rangeAlternatives == null, "Range alternatives already defined as %s",
34 this.rangeAlternatives);
35 this.rangeAlternatives = ImmutableList.copyOf(rangeAlternatives);
39 private static List<RangeConstraint> ensureResolvedRanges(final List<RangeConstraint> unresolved,
40 final List<RangeConstraint> baseRangeConstraints) {
41 // First check if we need to resolve anything at all
42 for (RangeConstraint c : unresolved) {
43 if (c.getMax() instanceof UnresolvedNumber || c.getMin() instanceof UnresolvedNumber) {
44 return resolveRanges(unresolved, baseRangeConstraints);
48 // No need, just return the same list
52 private static List<RangeConstraint> resolveRanges(final List<RangeConstraint> unresolved,
53 final List<RangeConstraint> baseRangeConstraints) {
54 final Builder<RangeConstraint> builder = ImmutableList.builder();
56 for (RangeConstraint c : unresolved) {
57 final Number max = c.getMax();
58 final Number min = c.getMin();
60 if (max instanceof UnresolvedNumber || min instanceof UnresolvedNumber) {
61 final Number rMax = max instanceof UnresolvedNumber
62 ? ((UnresolvedNumber)max).resolveRange(baseRangeConstraints) : max;
63 final Number rMin = min instanceof UnresolvedNumber
64 ? ((UnresolvedNumber)min).resolveRange(baseRangeConstraints) : min;
66 builder.add(BaseConstraints.newRangeConstraint(rMin, rMax, Optional.fromNullable(c.getDescription()),
67 Optional.fromNullable(c.getReference()), c.getErrorAppTag(), c.getErrorMessage()));
74 return builder.build();
77 private static List<RangeConstraint> ensureTypedRanges(final List<RangeConstraint> ranges,
78 final Class<? extends Number> clazz) {
79 for (RangeConstraint c : ranges) {
80 if (!clazz.isInstance(c.getMin()) || !clazz.isInstance(c.getMax())) {
81 return typedRanges(ranges, clazz);
88 private static List<RangeConstraint> typedRanges(final List<RangeConstraint> ranges,
89 final Class<? extends Number> clazz) {
90 final Function<Number, Number> function = NumberUtil.converterTo(clazz);
91 Preconditions.checkArgument(function != null, "Unsupported range class %s", clazz);
93 final Builder<RangeConstraint> builder = ImmutableList.builder();
95 for (RangeConstraint c : ranges) {
96 if (!clazz.isInstance(c.getMin()) || !clazz.isInstance(c.getMax())) {
101 min = function.apply(c.getMin());
102 max = function.apply(c.getMax());
103 } catch (NumberFormatException e) {
104 throw new IllegalArgumentException(String.format("Constraint %s does not fit into range of %s",
105 c, clazz.getSimpleName()), e);
107 builder.add(BaseConstraints.newRangeConstraint(min, max, Optional.fromNullable(c.getDescription()),
108 Optional.fromNullable(c.getReference()), c.getErrorAppTag(), c.getErrorMessage()));
114 return builder.build();
117 private static boolean rangeCovered(final List<RangeConstraint> where,
118 final RangeConstraint what) {
119 for (RangeConstraint c : where) {
120 if (NumberUtil.isRangeCovered(what.getMin(), what.getMax(), c.getMin(), c.getMax())) {
128 final List<RangeConstraint> calculateRangeConstraints(final List<RangeConstraint> baseRangeConstraints) {
129 if (rangeAlternatives == null || rangeAlternatives.isEmpty()) {
130 return baseRangeConstraints;
133 // Run through alternatives and resolve them against the base type
134 Verify.verify(!baseRangeConstraints.isEmpty(), "Base type %s does not define constraints", getBaseType());
135 final List<RangeConstraint> resolvedRanges = ensureResolvedRanges(rangeAlternatives, baseRangeConstraints);
137 // Next up, ensure the of boundaries match base constraints
138 final Class<? extends Number> clazz = baseRangeConstraints.get(0).getMin().getClass();
139 final List<RangeConstraint> typedRanges = ensureTypedRanges(resolvedRanges, clazz);
141 // Now verify if new ranges are strict subset of base ranges
142 for (RangeConstraint c : typedRanges) {
143 if (!rangeCovered(baseRangeConstraints, c)) {
144 throw new InvalidRangeConstraintException(c,
145 "Range constraint %s is not a subset of parent constraints %s", c, baseRangeConstraints);