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.DeclarationReference;
19 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
20 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
21 import org.opendaylight.yangtools.yang.model.api.stmt.LengthEffectiveStatement;
22 import org.opendaylight.yangtools.yang.model.api.stmt.LengthStatement;
23 import org.opendaylight.yangtools.yang.model.api.stmt.UnresolvedNumber;
24 import org.opendaylight.yangtools.yang.model.api.stmt.ValueRange;
25 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
26 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
27 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
28 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
29 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.ArgumentUtils;
30 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
31 import org.opendaylight.yangtools.yang.parser.spi.meta.BoundStmtCtx;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
35 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
36 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
38 public final class LengthStatementSupport
39 extends AbstractStatementSupport<List<ValueRange>, LengthStatement, LengthEffectiveStatement> {
40 private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
41 SubstatementValidator.builder(YangStmtMapping.LENGTH)
42 .addOptional(YangStmtMapping.DESCRIPTION)
43 .addOptional(YangStmtMapping.ERROR_APP_TAG)
44 .addOptional(YangStmtMapping.ERROR_MESSAGE)
45 .addOptional(YangStmtMapping.REFERENCE)
48 public LengthStatementSupport(final YangParserConfiguration config) {
49 super(YangStmtMapping.LENGTH, StatementPolicy.contextIndependent(), config, SUBSTATEMENT_VALIDATOR);
53 public ImmutableList<ValueRange> parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
54 final List<ValueRange> ranges = new ArrayList<>();
56 for (final String singleRange : ArgumentUtils.PIPE_SPLITTER.split(value)) {
57 final Iterator<String> boundaries = ArgumentUtils.TWO_DOTS_SPLITTER.split(singleRange).iterator();
58 final Number min = parseIntegerConstraintValue(ctx, boundaries.next());
61 if (boundaries.hasNext()) {
62 max = parseIntegerConstraintValue(ctx, boundaries.next());
64 // if min larger than max then error
65 SourceException.throwIf(ArgumentUtils.compareNumbers(min, max) == 1, ctx,
66 "Length constraint %s has descending order of boundaries; should be ascending.", singleRange);
67 SourceException.throwIf(boundaries.hasNext(), ctx,
68 "Wrong number of boundaries in length constraint %s.", singleRange);
73 // some of intervals overlapping
74 InferenceException.throwIf(
75 ranges.size() > 1 && ArgumentUtils.compareNumbers(min, Iterables.getLast(ranges).upperBound()) != 1,
76 ctx, "Some of the length ranges in %s are not disjoint", value);
77 ranges.add(ValueRange.of(min, max));
80 return ImmutableList.copyOf(ranges);
84 protected LengthStatement createDeclared(final BoundStmtCtx<List<ValueRange>> ctx,
85 final ImmutableList<DeclaredStatement<?>> substatements) {
86 return DeclaredStatements.createLength(ctx.getRawArgument(), ctx.getArgument(), substatements);
90 protected LengthStatement attachDeclarationReference(final LengthStatement stmt,
91 final DeclarationReference reference) {
92 return DeclaredStatementDecorators.decorateLength(stmt, reference);
96 protected LengthEffectiveStatement createEffective(final Current<List<ValueRange>, LengthStatement> stmt,
97 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
98 return EffectiveStatements.createLength(stmt.declared(), substatements);
101 private static @NonNull Number parseIntegerConstraintValue(final StmtContext<?, ?, ?> ctx, final String value) {
102 if ("max".equals(value)) {
103 return UnresolvedNumber.max();
105 if ("min".equals(value)) {
106 return UnresolvedNumber.min();
109 // As per RFC6020/RFC7950 section 9.4.4:
111 // An implementation is not required to support a length value larger than 18446744073709551615.
113 // We could support bigger precision at the cost of additional memory and/or potential ValueRange upper/lower
114 // bound inconsistency. We also take advantage of Uint64's interning facilities.
116 return Uint64.valueOf(value).intern();
117 } catch (NumberFormatException e) {
118 throw new SourceException(ctx, e, "Value %s is not a valid unsigned integer", value);
119 } catch (IllegalArgumentException e) {
120 throw new SourceException(ctx, e, "Value %s exceeds maximum supported value %s", value, Uint64.MAX_VALUE);