yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/ListStatementImpl.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. 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.stmt.rfc6020;
   9
  10 import java.util.Collection;
  11 import javax.annotation.Nonnull;
  12 import javax.annotation.Nullable;
  13 import org.opendaylight.yangtools.yang.common.QName;
  14 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  15 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  16 import org.opendaylight.yangtools.yang.model.api.stmt.ActionStatement;
  17 import org.opendaylight.yangtools.yang.model.api.stmt.ConfigStatement;
  18 import org.opendaylight.yangtools.yang.model.api.stmt.DataDefinitionStatement;
  19 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionStatement;
  20 import org.opendaylight.yangtools.yang.model.api.stmt.GroupingStatement;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.IfFeatureStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.KeyStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.ListStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.MaxElementsStatement;
  25 import org.opendaylight.yangtools.yang.model.api.stmt.MinElementsStatement;
  26 import org.opendaylight.yangtools.yang.model.api.stmt.MustStatement;
  27 import org.opendaylight.yangtools.yang.model.api.stmt.NotificationStatement;
  28 import org.opendaylight.yangtools.yang.model.api.stmt.OrderedByStatement;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceStatement;
  30 import org.opendaylight.yangtools.yang.model.api.stmt.StatusStatement;
  31 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefStatement;
  32 import org.opendaylight.yangtools.yang.model.api.stmt.UniqueStatement;
  33 import org.opendaylight.yangtools.yang.model.api.stmt.WhenStatement;
  34 import org.opendaylight.yangtools.yang.parser.spi.SubstatementValidator;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  38 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  39 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.ListEffectiveStatementImpl;
  40
  41 public class ListStatementImpl extends AbstractDeclaredStatement<QName>
  42         implements ListStatement {
  43     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(YangStmtMapping
  44             .LIST)
  45             .addAny(YangStmtMapping.ANYXML)
  46             .addAny(YangStmtMapping.CHOICE)
  47             .addOptional(YangStmtMapping.CONFIG)
  48             .addAny(YangStmtMapping.CONTAINER)
  49             .addOptional(YangStmtMapping.DESCRIPTION)
  50             .addAny(YangStmtMapping.GROUPING)
  51             .addAny(YangStmtMapping.IF_FEATURE)
  52             .addOptional(YangStmtMapping.KEY)
  53             .addAny(YangStmtMapping.LEAF)
  54             .addAny(YangStmtMapping.LEAF_LIST)
  55             .addAny(YangStmtMapping.LIST)
  56             .addOptional(YangStmtMapping.MAX_ELEMENTS)
  57             .addOptional(YangStmtMapping.MIN_ELEMENTS)
  58             .addAny(YangStmtMapping.MUST)
  59             .addOptional(YangStmtMapping.ORDERED_BY)
  60             .addOptional(YangStmtMapping.REFERENCE)
  61             .addOptional(YangStmtMapping.STATUS)
  62             .addAny(YangStmtMapping.TYPEDEF)
  63             .addAny(YangStmtMapping.UNIQUE)
  64             .addAny(YangStmtMapping.USES)
  65             .addOptional(YangStmtMapping.WHEN)
  66             .build();
  67
  68     protected ListStatementImpl(final StmtContext<QName, ListStatement, ?> context) {
  69         super(context);
  70     }
  71
  72     public static class Definition
  73             extends
  74             AbstractStatementSupport<QName, ListStatement, EffectiveStatement<QName, ListStatement>> {
  75
  76         public Definition() {
  77             super(YangStmtMapping.LIST);
  78         }
  79
  80         @Override
  81         public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  82             return Utils.qNameFromArgument(ctx, value);
  83         }
  84
  85         @Override
  86         public void onStatementAdded(final Mutable<QName, ListStatement, EffectiveStatement<QName, ListStatement>> stmt) {
  87             stmt.getParentContext().addToNs(ChildSchemaNodes.class, stmt.getStatementArgument(), stmt);
  88         }
  89
  90         @Override
  91         public ListStatement createDeclared(
  92                 final StmtContext<QName, ListStatement, ?> ctx) {
  93             return new ListStatementImpl(ctx);
  94         }
  95
  96         @Override
  97         public EffectiveStatement<QName, ListStatement> createEffective(
  98                 final StmtContext<QName, ListStatement, EffectiveStatement<QName, ListStatement>> ctx) {
  99             return new ListEffectiveStatementImpl(ctx);
 100         }
 101
 102         @Override
 103         public void onFullDefinitionDeclared(final Mutable<QName, ListStatement,
 104                 EffectiveStatement<QName, ListStatement>> stmt) {
 105             super.onFullDefinitionDeclared(stmt);
 106             getSubstatementValidator().validate(stmt);
 107         }
 108
 109         @Override
 110         protected SubstatementValidator getSubstatementValidator() {
 111             return SUBSTATEMENT_VALIDATOR;
 112         }
 113     }
 114
 115     @Nonnull
 116     @Override
 117     public QName getName() {
 118         return argument();
 119     }
 120
 121     @Nullable
 122     @Override
 123     public ConfigStatement getConfig() {
 124         return firstDeclared(ConfigStatement.class);
 125     }
 126
 127     @Override
 128     public WhenStatement getWhenStatement() {
 129         return firstDeclared(WhenStatement.class);
 130     }
 131
 132     @Nonnull
 133     @Override
 134     public Collection<? extends IfFeatureStatement> getIfFeatures() {
 135         return allDeclared(IfFeatureStatement.class);
 136     }
 137
 138     @Nullable
 139     @Override
 140     public StatusStatement getStatus() {
 141         return firstDeclared(StatusStatement.class);
 142     }
 143
 144     @Nullable
 145     @Override
 146     public DescriptionStatement getDescription() {
 147         return firstDeclared(DescriptionStatement.class);
 148     }
 149
 150     @Nullable
 151     @Override
 152     public ReferenceStatement getReference() {
 153         return firstDeclared(ReferenceStatement.class);
 154     }
 155
 156     @Override
 157     public MinElementsStatement getMinElements() {
 158         return firstDeclared(MinElementsStatement.class);
 159     }
 160
 161     @Override
 162     public MaxElementsStatement getMaxElements() {
 163         return firstDeclared(MaxElementsStatement.class);
 164     }
 165
 166     @Override
 167     public OrderedByStatement getOrderedBy() {
 168         return firstDeclared(OrderedByStatement.class);
 169     }
 170
 171     @Nonnull
 172     @Override
 173     public Collection<? extends TypedefStatement> getTypedefs() {
 174         return allDeclared(TypedefStatement.class);
 175     }
 176
 177     @Nonnull
 178     @Override
 179     public Collection<? extends GroupingStatement> getGroupings() {
 180         return allDeclared(GroupingStatement.class);
 181     }
 182
 183     @Nonnull
 184     @Override
 185     public Collection<? extends DataDefinitionStatement> getDataDefinitions() {
 186         return allDeclared(DataDefinitionStatement.class);
 187     }
 188
 189     @Nonnull
 190     @Override
 191     public Collection<? extends MustStatement> getMusts() {
 192         return allDeclared(MustStatement.class);
 193     }
 194
 195     @Override
 196     public KeyStatement getKey() {
 197         return firstDeclared(KeyStatement.class);
 198     }
 199
 200     @Nonnull
 201     @Override
 202     public Collection<? extends UniqueStatement> getUnique() {
 203         return allDeclared(UniqueStatement.class);
 204     }
 205
 206     @Nonnull
 207     @Override
 208     public Collection<? extends ActionStatement> getActions() {
 209         return allDeclared(ActionStatement.class);
 210     }
 211
 212     @Override
 213     public final Collection<? extends NotificationStatement> getNotifications() {
 214         return allDeclared(NotificationStatement.class);
 215     }
 216 }