yang/rfc8528-parser-support/src/main/java/org/opendaylight/yangtools/rfc8528/parser/MountPointStatementSupport.java

   1 /*
   2  * Copyright (c) 2019 PANTHEON.tech, 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.rfc8528.parser;
   9
  10 import com.google.common.collect.ImmutableList;
  11 import org.eclipse.jdt.annotation.NonNull;
  12 import org.opendaylight.yangtools.rfc8528.model.api.MountPointEffectiveStatement;
  13 import org.opendaylight.yangtools.rfc8528.model.api.MountPointStatement;
  14 import org.opendaylight.yangtools.rfc8528.model.api.SchemaMountStatements;
  15 import org.opendaylight.yangtools.yang.common.QName;
  16 import org.opendaylight.yangtools.yang.common.QNameModule;
  17 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  18 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  19 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  20 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  21 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  22 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractQNameStatementSupport;
  23 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  24 import org.opendaylight.yangtools.yang.parser.spi.meta.SchemaPathSupport;
  25 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  26 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  29 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  30
  31 public final class MountPointStatementSupport
  32         extends AbstractQNameStatementSupport<MountPointStatement, MountPointEffectiveStatement> {
  33     private static final SubstatementValidator VALIDATOR =
  34         SubstatementValidator.builder(SchemaMountStatements.MOUNT_POINT)
  35             .addOptional(YangStmtMapping.CONFIG)
  36             .addOptional(YangStmtMapping.DESCRIPTION)
  37             .addOptional(YangStmtMapping.REFERENCE)
  38             .addOptional(YangStmtMapping.STATUS)
  39             .build();
  40
  41     public MountPointStatementSupport(final YangParserConfiguration config) {
  42         super(SchemaMountStatements.MOUNT_POINT, StatementPolicy.copyDeclared((copy, current, substatements) ->
  43             copy.getArgument().equals(current.getArgument())
  44             // Implied by UnknownSchemaNode
  45             && copy.history().isAugmenting() == current.history().isAugmenting()
  46             && copy.history().isAddedByUses() == current.history().isAddedByUses()
  47             && copy.equalParentPath(current)), config);
  48     }
  49
  50     // FIXME: these two methods are not quite right. RFC8528 states that:
  51     //
  52     //    If a mount point is defined within a grouping, its label is
  53     //    bound to the module where the grouping is used.
  54     //
  55     // We are not doing exactly that, in that we can end up rebinding the argument through 'augment', I think.
  56     @Override
  57     public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  58         return StmtContextUtils.parseIdentifier(ctx, value);
  59     }
  60
  61     @Override
  62     public QName adaptArgumentValue(final StmtContext<QName, MountPointStatement, MountPointEffectiveStatement> ctx,
  63             final QNameModule targetModule) {
  64         return ctx.getArgument().bindTo(targetModule).intern();
  65     }
  66
  67     @Override
  68     public void onStatementAdded(final Mutable<QName, MountPointStatement, MountPointEffectiveStatement> stmt) {
  69         final StatementDefinition parentDef = stmt.coerceParentContext().publicDefinition();
  70         SourceException.throwIf(YangStmtMapping.CONTAINER != parentDef && YangStmtMapping.LIST != parentDef, stmt,
  71             "Mount points may only be defined at either a container or a list");
  72     }
  73
  74     @Override
  75     protected SubstatementValidator getSubstatementValidator() {
  76         return VALIDATOR;
  77     }
  78
  79     @Override
  80     protected MountPointStatement createDeclared(@NonNull final StmtContext<QName, MountPointStatement, ?> ctx,
  81             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  82         return new MountPointStatementImpl(ctx.getArgument(), substatements);
  83     }
  84
  85     @Override
  86     protected MountPointEffectiveStatement createEffective(final Current<QName, MountPointStatement> stmt,
  87             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
  88         return new MountPointEffectiveStatementImpl(stmt, substatements, SchemaPathSupport.toOptionalPath(
  89             stmt.getEffectiveParent().getSchemaPath().createChild(stmt.getArgument())));
  90     }
  91 }