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.parser.rfc7950.stmt.BaseStatementSupport;
  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;
  23
  24 public final class OrderedByStatementSupport
  25         extends BaseStatementSupport<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();
  29
  30     /*
  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).
  33      */
  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);
  42
  43     private OrderedByStatementSupport() {
  44         super(YangStmtMapping.ORDERED_BY, StatementPolicy.contextIndependent());
  45     }
  46
  47     public static OrderedByStatementSupport getInstance() {
  48         return INSTANCE;
  49     }
  50
  51     @Override
  52     public Ordering parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  53         try {
  54             return Ordering.forArgument(value);
  55         } catch (IllegalArgumentException e) {
  56             throw new SourceException(ctx, e, "Invalid ordered-by argument '%s'", value);
  57         }
  58     }
  59
  60     @Override
  61     public String internArgument(final String rawArgument) {
  62         if ("user".equals(rawArgument)) {
  63             return "user";
  64         } else if ("system".equals(rawArgument)) {
  65             return "system";
  66         } else {
  67             return rawArgument;
  68         }
  69     }
  70
  71     @Override
  72     protected SubstatementValidator getSubstatementValidator() {
  73         return SUBSTATEMENT_VALIDATOR;
  74     }
  75
  76     @Override
  77     protected OrderedByStatement createDeclared(final StmtContext<Ordering, OrderedByStatement, ?> ctx,
  78             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  79         return new RegularOrderedByStatement(ctx.getArgument(), substatements);
  80     }
  81
  82     @Override
  83     protected OrderedByStatement createEmptyDeclared(final StmtContext<Ordering, OrderedByStatement, ?> ctx) {
  84         final Ordering argument = ctx.getArgument();
  85         switch (argument) {
  86             case SYSTEM:
  87                 return EMPTY_SYSTEM_DECL;
  88             case USER:
  89                 return EMPTY_USER_DECL;
  90             default:
  91                 throw new IllegalStateException("Unhandled argument " + argument);
  92         }
  93     }
  94
  95     @Override
  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);
 100     }
 101
 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;
 110         } else {
 111             return new EmptyOrderedByEffectiveStatement(declared);
 112         }
 113     }
 114 }