yang/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.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;
  26
  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();
  31
  32     /*
  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).
  35      */
  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);
  45
  46     public OrderedByStatementSupport(final YangParserConfiguration config) {
  47         super(YangStmtMapping.ORDERED_BY, StatementPolicy.contextIndependent(), config);
  48     }
  49
  50     @Override
  51     public Ordering parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  52         try {
  53             return Ordering.forArgument(value);
  54         } catch (IllegalArgumentException e) {
  55             throw new SourceException(ctx, e, "Invalid ordered-by argument '%s'", value);
  56         }
  57     }
  58
  59     @Override
  60     public String internArgument(final String rawArgument) {
  61         if ("user".equals(rawArgument)) {
  62             return "user";
  63         } else if ("system".equals(rawArgument)) {
  64             return "system";
  65         } else {
  66             return rawArgument;
  67         }
  68     }
  69
  70     @Override
  71     protected SubstatementValidator getSubstatementValidator() {
  72         return SUBSTATEMENT_VALIDATOR;
  73     }
  74
  75     @Override
  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();
  80             switch (argument) {
  81                 case SYSTEM:
  82                     return EMPTY_SYSTEM_DECL;
  83                 case USER:
  84                     return EMPTY_USER_DECL;
  85                 default:
  86                     throw new IllegalStateException("Unhandled argument " + argument);
  87             }
  88         } else {
  89             return DeclaredStatements.createOrderedBy(ctx.getArgument(), substatements);
  90         }
  91     }
  92
  93     @Override
  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);
  98     }
  99
 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;
 108         } else {
 109             return EffectiveStatements.createOrderedBy(declared);
 110         }
 111     }
 112 }