2 * Copyright (c) 2017 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.parser.rfc7950.stmt.meta;
10 import com.google.common.collect.ImmutableList;
11 import com.google.common.collect.Iterables;
12 import java.util.ArrayList;
13 import java.util.Iterator;
14 import java.util.List;
15 import org.eclipse.jdt.annotation.NonNull;
16 import org.opendaylight.yangtools.yang.common.Uint64;
17 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
18 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
19 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
20 import org.opendaylight.yangtools.yang.model.api.stmt.LengthEffectiveStatement;
21 import org.opendaylight.yangtools.yang.model.api.stmt.LengthStatement;
22 import org.opendaylight.yangtools.yang.model.api.stmt.UnresolvedNumber;
23 import org.opendaylight.yangtools.yang.model.api.stmt.ValueRange;
24 import org.opendaylight.yangtools.yang.model.parser.api.YangParserConfiguration;
25 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
26 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
27 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.ArgumentUtils;
28 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
29 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
30 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
31 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
33 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
35 public final class LengthStatementSupport
36 extends AbstractStatementSupport<List<ValueRange>, LengthStatement, LengthEffectiveStatement> {
37 private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
38 SubstatementValidator.builder(YangStmtMapping.LENGTH)
39 .addOptional(YangStmtMapping.DESCRIPTION)
40 .addOptional(YangStmtMapping.ERROR_APP_TAG)
41 .addOptional(YangStmtMapping.ERROR_MESSAGE)
42 .addOptional(YangStmtMapping.REFERENCE)
45 public LengthStatementSupport(final YangParserConfiguration config) {
46 super(YangStmtMapping.LENGTH, StatementPolicy.contextIndependent(), config);
50 public ImmutableList<ValueRange> parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
51 final List<ValueRange> ranges = new ArrayList<>();
53 for (final String singleRange : ArgumentUtils.PIPE_SPLITTER.split(value)) {
54 final Iterator<String> boundaries = ArgumentUtils.TWO_DOTS_SPLITTER.split(singleRange).iterator();
55 final Number min = parseIntegerConstraintValue(ctx, boundaries.next());
58 if (boundaries.hasNext()) {
59 max = parseIntegerConstraintValue(ctx, boundaries.next());
61 // if min larger than max then error
62 SourceException.throwIf(ArgumentUtils.compareNumbers(min, max) == 1, ctx,
63 "Length constraint %s has descending order of boundaries; should be ascending.", singleRange);
64 SourceException.throwIf(boundaries.hasNext(), ctx,
65 "Wrong number of boundaries in length constraint %s.", singleRange);
70 // some of intervals overlapping
71 InferenceException.throwIf(
72 ranges.size() > 1 && ArgumentUtils.compareNumbers(min, Iterables.getLast(ranges).upperBound()) != 1,
73 ctx, "Some of the length ranges in %s are not disjoint", value);
74 ranges.add(ValueRange.of(min, max));
77 return ImmutableList.copyOf(ranges);
81 protected SubstatementValidator getSubstatementValidator() {
82 return SUBSTATEMENT_VALIDATOR;
86 protected LengthStatement createDeclared(final StmtContext<List<ValueRange>, LengthStatement, ?> ctx,
87 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
88 return DeclaredStatements.createLength(ctx.getRawArgument(), ctx.getArgument(), substatements);
92 protected LengthEffectiveStatement createEffective(final Current<List<ValueRange>, LengthStatement> stmt,
93 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
94 return EffectiveStatements.createLength(stmt.declared(), substatements);
97 private static @NonNull Number parseIntegerConstraintValue(final StmtContext<?, ?, ?> ctx, final String value) {
98 if ("max".equals(value)) {
99 return UnresolvedNumber.max();
101 if ("min".equals(value)) {
102 return UnresolvedNumber.min();
105 // As per RFC6020/RFC7950 section 9.4.4:
107 // An implementation is not required to support a length value larger than 18446744073709551615.
109 // We could support bigger precision at the cost of additional memory and/or potential ValueRange upper/lower
110 // bound inconsistency. We also take advantage of Uint64's interning facilities.
112 return Uint64.valueOf(value).intern();
113 } catch (NumberFormatException e) {
114 throw new SourceException(ctx, e, "Value %s is not a valid unsigned integer", value);
115 } catch (IllegalArgumentException e) {
116 throw new SourceException(ctx, e, "Value %s exceeds maximum supported value %s", value, Uint64.MAX_VALUE);