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.BoundStmtCtx;
  25 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  26 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  28 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  29
  30 public final class OrderedByStatementSupport
  31         extends AbstractStatementSupport<Ordering, OrderedByStatement, OrderedByEffectiveStatement> {
  32     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
  33             SubstatementValidator.builder(YangStmtMapping.ORDERED_BY).build();
  34
  35     /*
  36      * Ordered-by has low argument cardinality, hence we can reuse them in case declaration does not have any
  37      * substatements (which is the usual case).
  38      */
  39     // FIXME: move this to yang-model-spi
  40     private static final @NonNull OrderedByStatement EMPTY_SYSTEM_DECL =
  41         DeclaredStatements.createOrderedBy(Ordering.SYSTEM);
  42     private static final @NonNull OrderedByStatement EMPTY_USER_DECL =
  43         DeclaredStatements.createOrderedBy(Ordering.USER);
  44     private static final @NonNull OrderedByEffectiveStatement EMPTY_SYSTEM_EFF =
  45         EffectiveStatements.createOrderedBy(EMPTY_SYSTEM_DECL);
  46     private static final @NonNull OrderedByEffectiveStatement EMPTY_USER_EFF =
  47         EffectiveStatements.createOrderedBy(EMPTY_USER_DECL);
  48
  49     public OrderedByStatementSupport(final YangParserConfiguration config) {
  50         super(YangStmtMapping.ORDERED_BY, StatementPolicy.contextIndependent(), config, SUBSTATEMENT_VALIDATOR);
  51     }
  52
  53     @Override
  54     public Ordering parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  55         try {
  56             return Ordering.forArgument(value);
  57         } catch (IllegalArgumentException e) {
  58             throw new SourceException(ctx, e, "Invalid ordered-by argument '%s'", value);
  59         }
  60     }
  61
  62     @Override
  63     public String internArgument(final String rawArgument) {
  64         if ("user".equals(rawArgument)) {
  65             return "user";
  66         } else if ("system".equals(rawArgument)) {
  67             return "system";
  68         } else {
  69             return rawArgument;
  70         }
  71     }
  72
  73     @Override
  74     protected OrderedByStatement createDeclared(final BoundStmtCtx<Ordering> ctx,
  75             final ImmutableList<DeclaredStatement<?>> substatements) {
  76         if (substatements.isEmpty()) {
  77             final Ordering argument = ctx.getArgument();
  78             switch (argument) {
  79                 case SYSTEM:
  80                     return EMPTY_SYSTEM_DECL;
  81                 case USER:
  82                     return EMPTY_USER_DECL;
  83                 default:
  84                     throw new IllegalStateException("Unhandled argument " + argument);
  85             }
  86         } else {
  87             return DeclaredStatements.createOrderedBy(ctx.getArgument(), substatements);
  88         }
  89     }
  90
  91     @Override
  92     protected OrderedByStatement attachDeclarationReference(final OrderedByStatement stmt,
  93             final DeclarationReference reference) {
  94         return DeclaredStatementDecorators.decorateOrderedBy(stmt, reference);
  95     }
  96
  97     @Override
  98     protected OrderedByEffectiveStatement createEffective(final Current<Ordering, OrderedByStatement> stmt,
  99             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 100         return substatements.isEmpty() ? createEmptyEffective(stmt.declared())
 101             : EffectiveStatements.createOrderedBy(stmt.declared(), substatements);
 102     }
 103
 104     private static @NonNull OrderedByEffectiveStatement createEmptyEffective(final OrderedByStatement declared) {
 105         // Aggressively reuse effective instances which are backed by the corresponding empty declared instance, as this
 106         // is the case unless there is a weird extension in use.
 107         if (EMPTY_USER_DECL.equals(declared)) {
 108             // Most likely to be seen (as system is the default)
 109             return EMPTY_USER_EFF;
 110         } else if (EMPTY_SYSTEM_DECL.equals(declared)) {
 111             return EMPTY_SYSTEM_EFF;
 112         } else {
 113             return EffectiveStatements.createOrderedBy(declared);
 114         }
 115     }
 116 }