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.ordered_by;
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.parser.spi.meta.AbstractStatementSupport;
19 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
20 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
21 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
22 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
24 public final class OrderedByStatementSupport
25 extends AbstractStatementSupport<Ordering, OrderedByStatement, OrderedByEffectiveStatement> {
26 private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
27 SubstatementValidator.builder(YangStmtMapping.ORDERED_BY).build();
28 private static final OrderedByStatementSupport INSTANCE = new OrderedByStatementSupport();
31 * Ordered-by has low argument cardinality, hence we can reuse them in case declaration does not have any
32 * substatements (which is the usual case).
34 private static final @NonNull EmptyOrderedByStatement EMPTY_SYSTEM_DECL =
35 new EmptyOrderedByStatement(Ordering.SYSTEM);
36 private static final @NonNull EmptyOrderedByStatement EMPTY_USER_DECL =
37 new EmptyOrderedByStatement(Ordering.USER);
38 private static final @NonNull EmptyOrderedByEffectiveStatement EMPTY_SYSTEM_EFF =
39 new EmptyOrderedByEffectiveStatement(EMPTY_SYSTEM_DECL);
40 private static final @NonNull EmptyOrderedByEffectiveStatement EMPTY_USER_EFF =
41 new EmptyOrderedByEffectiveStatement(EMPTY_USER_DECL);
43 private OrderedByStatementSupport() {
44 super(YangStmtMapping.ORDERED_BY, StatementPolicy.contextIndependent());
47 public static OrderedByStatementSupport getInstance() {
52 public Ordering parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
54 return Ordering.forArgument(value);
55 } catch (IllegalArgumentException e) {
56 throw new SourceException(ctx, e, "Invalid ordered-by argument '%s'", value);
61 public String internArgument(final String rawArgument) {
62 if ("user".equals(rawArgument)) {
64 } else if ("system".equals(rawArgument)) {
72 protected SubstatementValidator getSubstatementValidator() {
73 return SUBSTATEMENT_VALIDATOR;
77 protected OrderedByStatement createDeclared(final StmtContext<Ordering, OrderedByStatement, ?> ctx,
78 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
79 return new RegularOrderedByStatement(ctx.getArgument(), substatements);
83 protected OrderedByStatement createEmptyDeclared(final StmtContext<Ordering, OrderedByStatement, ?> ctx) {
84 final Ordering argument = ctx.getArgument();
87 return EMPTY_SYSTEM_DECL;
89 return EMPTY_USER_DECL;
91 throw new IllegalStateException("Unhandled argument " + argument);
96 protected OrderedByEffectiveStatement createEffective(final Current<Ordering, OrderedByStatement> stmt,
97 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
98 return substatements.isEmpty() ? createEmptyEffective(stmt.declared())
99 : new RegularOrderedByEffectiveStatement(stmt.declared(), substatements);
102 private static @NonNull OrderedByEffectiveStatement createEmptyEffective(final OrderedByStatement declared) {
103 // Aggressively reuse effective instances which are backed by the corresponding empty declared instance, as this
104 // is the case unless there is a weird extension in use.
105 if (EMPTY_USER_DECL.equals(declared)) {
106 // Most likely to be seen (as system is the default)
107 return EMPTY_USER_EFF;
108 } else if (EMPTY_SYSTEM_DECL.equals(declared)) {
109 return EMPTY_SYSTEM_EFF;
111 return new EmptyOrderedByEffectiveStatement(declared);