yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/ordered_by/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.ordered_by;
   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.ri.stmt.DeclaredStatements;
  19 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
  20 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  21 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  22 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  23 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  24 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  25
  26 public final class OrderedByStatementSupport
  27         extends AbstractStatementSupport<Ordering, OrderedByStatement, OrderedByEffectiveStatement> {
  28     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
  29             SubstatementValidator.builder(YangStmtMapping.ORDERED_BY).build();
  30     private static final OrderedByStatementSupport INSTANCE = new OrderedByStatementSupport();
  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     private OrderedByStatementSupport() {
  47         super(YangStmtMapping.ORDERED_BY, StatementPolicy.contextIndependent());
  48     }
  49
  50     public static OrderedByStatementSupport getInstance() {
  51         return INSTANCE;
  52     }
  53
  54     @Override
  55     public Ordering parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  56         try {
  57             return Ordering.forArgument(value);
  58         } catch (IllegalArgumentException e) {
  59             throw new SourceException(ctx, e, "Invalid ordered-by argument '%s'", value);
  60         }
  61     }
  62
  63     @Override
  64     public String internArgument(final String rawArgument) {
  65         if ("user".equals(rawArgument)) {
  66             return "user";
  67         } else if ("system".equals(rawArgument)) {
  68             return "system";
  69         } else {
  70             return rawArgument;
  71         }
  72     }
  73
  74     @Override
  75     protected SubstatementValidator getSubstatementValidator() {
  76         return SUBSTATEMENT_VALIDATOR;
  77     }
  78
  79     @Override
  80     protected OrderedByStatement createDeclared(final StmtContext<Ordering, OrderedByStatement, ?> ctx,
  81             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  82         return DeclaredStatements.createOrderedBy(ctx.getArgument(), substatements);
  83     }
  84
  85     @Override
  86     protected OrderedByStatement createEmptyDeclared(final StmtContext<Ordering, OrderedByStatement, ?> ctx) {
  87         final Ordering argument = ctx.getArgument();
  88         switch (argument) {
  89             case SYSTEM:
  90                 return EMPTY_SYSTEM_DECL;
  91             case USER:
  92                 return EMPTY_USER_DECL;
  93             default:
  94                 throw new IllegalStateException("Unhandled argument " + argument);
  95         }
  96     }
  97
  98     @Override
  99     protected OrderedByEffectiveStatement createEffective(final Current<Ordering, OrderedByStatement> stmt,
 100             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 101         return substatements.isEmpty() ? createEmptyEffective(stmt.declared())
 102             : EffectiveStatements.createOrderedBy(stmt.declared(), substatements);
 103     }
 104
 105     private static @NonNull OrderedByEffectiveStatement createEmptyEffective(final OrderedByStatement declared) {
 106         // Aggressively reuse effective instances which are backed by the corresponding empty declared instance, as this
 107         // is the case unless there is a weird extension in use.
 108         if (EMPTY_USER_DECL.equals(declared)) {
 109             // Most likely to be seen (as system is the default)
 110             return EMPTY_USER_EFF;
 111         } else if (EMPTY_SYSTEM_DECL.equals(declared)) {
 112             return EMPTY_SYSTEM_EFF;
 113         } else {
 114             return EffectiveStatements.createOrderedBy(declared);
 115         }
 116     }
 117 }