parser/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/meta/OrderedByStatementSupport.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies, s.r.o. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.yangtools.yang.parser.rfc7950.stmt.meta;
   9
  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.ri.stmt.DeclaredStatementDecorators;
  20 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  21 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
  22 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  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;
  28
  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();
  33
  34     /*
  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).
  37      */
  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);
  47
  48     public OrderedByStatementSupport(final YangParserConfiguration config) {
  49         super(YangStmtMapping.ORDERED_BY, StatementPolicy.contextIndependent(), config, SUBSTATEMENT_VALIDATOR);
  50     }
  51
  52     @Override
  53     public Ordering parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  54         try {
  55             return Ordering.forArgument(value);
  56         } catch (IllegalArgumentException e) {
  57             throw new SourceException(ctx, e, "Invalid ordered-by argument '%s'", value);
  58         }
  59     }
  60
  61     @Override
  62     public String internArgument(final String rawArgument) {
  63         if ("user".equals(rawArgument)) {
  64             return "user";
  65         } else if ("system".equals(rawArgument)) {
  66             return "system";
  67         } else {
  68             return rawArgument;
  69         }
  70     }
  71
  72     @Override
  73     protected OrderedByStatement createDeclared(final StmtContext<Ordering, OrderedByStatement, ?> ctx,
  74             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  75         if (substatements.isEmpty()) {
  76             final Ordering argument = ctx.getArgument();
  77             switch (argument) {
  78                 case SYSTEM:
  79                     return EMPTY_SYSTEM_DECL;
  80                 case USER:
  81                     return EMPTY_USER_DECL;
  82                 default:
  83                     throw new IllegalStateException("Unhandled argument " + argument);
  84             }
  85         } else {
  86             return DeclaredStatements.createOrderedBy(ctx.getArgument(), substatements);
  87         }
  88     }
  89
  90     @Override
  91     protected OrderedByStatement attachDeclarationReference(final OrderedByStatement stmt,
  92             final DeclarationReference reference) {
  93         return DeclaredStatementDecorators.decorateOrderedBy(stmt, reference);
  94     }
  95
  96     @Override
  97     protected OrderedByEffectiveStatement createEffective(final Current<Ordering, OrderedByStatement> stmt,
  98             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
  99         return substatements.isEmpty() ? createEmptyEffective(stmt.declared())
 100             : EffectiveStatements.createOrderedBy(stmt.declared(), substatements);
 101     }
 102
 103     private static @NonNull OrderedByEffectiveStatement createEmptyEffective(final OrderedByStatement declared) {
 104         // Aggressively reuse effective instances which are backed by the corresponding empty declared instance, as this
 105         // is the case unless there is a weird extension in use.
 106         if (EMPTY_USER_DECL.equals(declared)) {
 107             // Most likely to be seen (as system is the default)
 108             return EMPTY_USER_EFF;
 109         } else if (EMPTY_SYSTEM_DECL.equals(declared)) {
 110             return EMPTY_SYSTEM_EFF;
 111         } else {
 112             return EffectiveStatements.createOrderedBy(declared);
 113         }
 114     }
 115 }