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 org.eclipse.jdt.annotation.NonNull;
12 import org.opendaylight.yangtools.yang.common.Ordering;
13 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
14 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
15 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
16 import org.opendaylight.yangtools.yang.model.api.stmt.OrderedByEffectiveStatement;
17 import org.opendaylight.yangtools.yang.model.api.stmt.OrderedByStatement;
18 import org.opendaylight.yangtools.yang.model.parser.api.YangParserConfiguration;
19 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
20 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
21 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
22 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
23 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
24 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
25 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
27 public final class OrderedByStatementSupport
28 extends AbstractStatementSupport<Ordering, OrderedByStatement, OrderedByEffectiveStatement> {
29 private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
30 SubstatementValidator.builder(YangStmtMapping.ORDERED_BY).build();
33 * Ordered-by has low argument cardinality, hence we can reuse them in case declaration does not have any
34 * substatements (which is the usual case).
36 // FIXME: move this to yang-model-spi
37 private static final @NonNull OrderedByStatement EMPTY_SYSTEM_DECL =
38 DeclaredStatements.createOrderedBy(Ordering.SYSTEM);
39 private static final @NonNull OrderedByStatement EMPTY_USER_DECL =
40 DeclaredStatements.createOrderedBy(Ordering.USER);
41 private static final @NonNull OrderedByEffectiveStatement EMPTY_SYSTEM_EFF =
42 EffectiveStatements.createOrderedBy(EMPTY_SYSTEM_DECL);
43 private static final @NonNull OrderedByEffectiveStatement EMPTY_USER_EFF =
44 EffectiveStatements.createOrderedBy(EMPTY_USER_DECL);
46 public OrderedByStatementSupport(final YangParserConfiguration config) {
47 super(YangStmtMapping.ORDERED_BY, StatementPolicy.contextIndependent(), config);
51 public Ordering parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
53 return Ordering.forArgument(value);
54 } catch (IllegalArgumentException e) {
55 throw new SourceException(ctx, e, "Invalid ordered-by argument '%s'", value);
60 public String internArgument(final String rawArgument) {
61 if ("user".equals(rawArgument)) {
63 } else if ("system".equals(rawArgument)) {
71 protected SubstatementValidator getSubstatementValidator() {
72 return SUBSTATEMENT_VALIDATOR;
76 protected OrderedByStatement createDeclared(final StmtContext<Ordering, OrderedByStatement, ?> ctx,
77 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
78 if (substatements.isEmpty()) {
79 final Ordering argument = ctx.getArgument();
82 return EMPTY_SYSTEM_DECL;
84 return EMPTY_USER_DECL;
86 throw new IllegalStateException("Unhandled argument " + argument);
89 return DeclaredStatements.createOrderedBy(ctx.getArgument(), substatements);
94 protected OrderedByEffectiveStatement createEffective(final Current<Ordering, OrderedByStatement> stmt,
95 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
96 return substatements.isEmpty() ? createEmptyEffective(stmt.declared())
97 : EffectiveStatements.createOrderedBy(stmt.declared(), substatements);
100 private static @NonNull OrderedByEffectiveStatement createEmptyEffective(final OrderedByStatement declared) {
101 // Aggressively reuse effective instances which are backed by the corresponding empty declared instance, as this
102 // is the case unless there is a weird extension in use.
103 if (EMPTY_USER_DECL.equals(declared)) {
104 // Most likely to be seen (as system is the default)
105 return EMPTY_USER_EFF;
106 } else if (EMPTY_SYSTEM_DECL.equals(declared)) {
107 return EMPTY_SYSTEM_EFF;
109 return EffectiveStatements.createOrderedBy(declared);