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.DeclarationReference;
15 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
16 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
17 import org.opendaylight.yangtools.yang.model.api.stmt.OrderedByEffectiveStatement;
18 import org.opendaylight.yangtools.yang.model.api.stmt.OrderedByStatement;
19 import org.opendaylight.yangtools.yang.model.parser.api.YangParserConfiguration;
20 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
21 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
22 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
23 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
24 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
25 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
26 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
27 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
29 public final class OrderedByStatementSupport
30 extends AbstractStatementSupport<Ordering, OrderedByStatement, OrderedByEffectiveStatement> {
31 private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
32 SubstatementValidator.builder(YangStmtMapping.ORDERED_BY).build();
35 * Ordered-by has low argument cardinality, hence we can reuse them in case declaration does not have any
36 * substatements (which is the usual case).
38 // FIXME: move this to yang-model-spi
39 private static final @NonNull OrderedByStatement EMPTY_SYSTEM_DECL =
40 DeclaredStatements.createOrderedBy(Ordering.SYSTEM);
41 private static final @NonNull OrderedByStatement EMPTY_USER_DECL =
42 DeclaredStatements.createOrderedBy(Ordering.USER);
43 private static final @NonNull OrderedByEffectiveStatement EMPTY_SYSTEM_EFF =
44 EffectiveStatements.createOrderedBy(EMPTY_SYSTEM_DECL);
45 private static final @NonNull OrderedByEffectiveStatement EMPTY_USER_EFF =
46 EffectiveStatements.createOrderedBy(EMPTY_USER_DECL);
48 public OrderedByStatementSupport(final YangParserConfiguration config) {
49 super(YangStmtMapping.ORDERED_BY, StatementPolicy.contextIndependent(), config);
53 public Ordering parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
55 return Ordering.forArgument(value);
56 } catch (IllegalArgumentException e) {
57 throw new SourceException(ctx, e, "Invalid ordered-by argument '%s'", value);
62 public String internArgument(final String rawArgument) {
63 if ("user".equals(rawArgument)) {
65 } else if ("system".equals(rawArgument)) {
73 protected SubstatementValidator getSubstatementValidator() {
74 return SUBSTATEMENT_VALIDATOR;
78 protected OrderedByStatement createDeclared(final StmtContext<Ordering, OrderedByStatement, ?> ctx,
79 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
80 if (substatements.isEmpty()) {
81 final Ordering argument = ctx.getArgument();
84 return EMPTY_SYSTEM_DECL;
86 return EMPTY_USER_DECL;
88 throw new IllegalStateException("Unhandled argument " + argument);
91 return DeclaredStatements.createOrderedBy(ctx.getArgument(), substatements);
96 protected OrderedByStatement attachDeclarationReference(final OrderedByStatement stmt,
97 final DeclarationReference reference) {
98 return DeclaredStatementDecorators.decorateOrderedBy(stmt, reference);
102 protected OrderedByEffectiveStatement createEffective(final Current<Ordering, OrderedByStatement> stmt,
103 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
104 return substatements.isEmpty() ? createEmptyEffective(stmt.declared())
105 : EffectiveStatements.createOrderedBy(stmt.declared(), substatements);
108 private static @NonNull OrderedByEffectiveStatement createEmptyEffective(final OrderedByStatement declared) {
109 // Aggressively reuse effective instances which are backed by the corresponding empty declared instance, as this
110 // is the case unless there is a weird extension in use.
111 if (EMPTY_USER_DECL.equals(declared)) {
112 // Most likely to be seen (as system is the default)
113 return EMPTY_USER_EFF;
114 } else if (EMPTY_SYSTEM_DECL.equals(declared)) {
115 return EMPTY_SYSTEM_EFF;
117 return EffectiveStatements.createOrderedBy(declared);