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.rfc7950.stmt.AbstractDeclaredStatement.WithQNameArgument.WithSubstatements;
  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
  34     private static final class Declared extends WithSubstatements implements MountPointStatement {
  35         Declared(final QName argument, final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  36             super(argument, substatements);
  37         }
  38     }
  39
  40     private static final MountPointStatementSupport INSTANCE = new MountPointStatementSupport(
  41         SchemaMountStatements.MOUNT_POINT);
  42
  43     private final SubstatementValidator validator;
  44
  45     MountPointStatementSupport(final StatementDefinition definition) {
  46         super(definition, StatementPolicy.copyDeclared((copy, current, substatements) ->
  47             copy.getArgument().equals(current.getArgument())
  48             // Implied by UnknownSchemaNode
  49             && copy.history().isAugmenting() == current.history().isAugmenting()
  50             && copy.history().isAddedByUses() == current.history().isAddedByUses()
  51             && copy.equalParentPath(current)));
  52         this.validator = SubstatementValidator.builder(definition)
  53                 .addOptional(YangStmtMapping.CONFIG)
  54                 .addOptional(YangStmtMapping.DESCRIPTION)
  55                 .addOptional(YangStmtMapping.REFERENCE)
  56                 .addOptional(YangStmtMapping.STATUS)
  57                 .build();
  58     }
  59
  60     public static MountPointStatementSupport getInstance() {
  61         return INSTANCE;
  62     }
  63
  64     // FIXME: these two methods are not quite right. RFC8528 states that:
  65     //
  66     //    If a mount point is defined within a grouping, its label is
  67     //    bound to the module where the grouping is used.
  68     //
  69     // We are not doing exactly that, in that we can end up rebinding the argument through 'augment', I think.
  70     @Override
  71     public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  72         return StmtContextUtils.parseIdentifier(ctx, value);
  73     }
  74
  75     @Override
  76     public QName adaptArgumentValue(final StmtContext<QName, MountPointStatement, MountPointEffectiveStatement> ctx,
  77             final QNameModule targetModule) {
  78         return ctx.getArgument().bindTo(targetModule).intern();
  79     }
  80
  81     @Override
  82     public void onStatementAdded(final Mutable<QName, MountPointStatement, MountPointEffectiveStatement> stmt) {
  83         final StatementDefinition parentDef = stmt.coerceParentContext().publicDefinition();
  84         SourceException.throwIf(YangStmtMapping.CONTAINER != parentDef && YangStmtMapping.LIST != parentDef, stmt,
  85             "Mount points may only be defined at either a container or a list");
  86     }
  87
  88     @Override
  89     protected SubstatementValidator getSubstatementValidator() {
  90         return validator;
  91     }
  92
  93     @Override
  94     protected MountPointStatement createDeclared(@NonNull final StmtContext<QName, MountPointStatement, ?> ctx,
  95             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  96         return new Declared(ctx.getArgument(), substatements);
  97     }
  98
  99     @Override
 100     protected MountPointStatement createEmptyDeclared(final StmtContext<QName, MountPointStatement, ?> ctx) {
 101         return createDeclared(ctx, ImmutableList.of());
 102     }
 103
 104     @Override
 105     protected MountPointEffectiveStatement createEffective(final Current<QName, MountPointStatement> stmt,
 106             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 107         return new MountPointEffectiveStatementImpl(stmt, substatements,
 108             SchemaPathSupport.wrap(stmt.getEffectiveParent().getSchemaPath().createChild(stmt.getArgument())));
 109     }
 110 }