org.opendaylight.yangtools.yang.parser.spi.SchemaTreeNamespaceBehaviour Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yangtools-docs Show documentation
YANG Tools documentation
There is a newer version: 14.0.4
/*
 * Copyright (c) 2022 PANTHEON.tech, s.r.o. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.yangtools.yang.parser.spi;

import java.util.Map;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeAwareEffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour;
import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceStorage;
import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceStorage.GlobalStorage;
import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceStorage.StorageType;
import org.opendaylight.yangtools.yang.parser.spi.meta.OnDemandSchemaTreeStorage;
import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;

/**
 * {@link NamespaceBehaviour} handling {@link ParserNamespaces#schemaTree()}.
 */
// FIXME: 11.0.0: this contract seems to fall on the reactor side of things rather than parser-spi. Consider moving this
//                into yang-(parser-)reactor-api.
final class SchemaTreeNamespaceBehaviour, E extends SchemaTreeEffectiveStatement>
        extends NamespaceBehaviour> {
    SchemaTreeNamespaceBehaviour() {
        super(ParserNamespaces.schemaTree());
    }

    /**
     * {@inheritDoc}
     *
     * 
     * This method is analogous to {@link SchemaTreeAwareEffectiveStatement#findSchemaTreeNode(QName)}.
     */
    @Override
    public StmtContext getFrom(final GlobalStorage global, final NamespaceStorage storage,
            final QName key) {
        // Get the backing storage node for the requested storage
        final NamespaceStorage storageNode = globalOrStatementSpecific(storage);
        // Check try to look up existing node
        final StmtContext existing = storageNode.getFromLocalStorage(namespace(), key);

        // An existing node takes precedence, if it does not exist try to request it
        return existing != null ? existing : requestFrom(storageNode, key);
    }

    @Override
    public Map> getAllFrom(final GlobalStorage global, final NamespaceStorage storage) {
        // FIXME: 7.0.0: this method needs to be well-defined
        return null;
    }

    @Override
    public void addTo(final GlobalStorage global, final NamespaceStorage storage, final QName key,
            final StmtContext value) {
        final var prev = globalOrStatementSpecific(storage).putToLocalStorageIfAbsent(namespace(), key, value);
        if (prev != null) {
            throw new SourceException(value,
                "Error in module '%s': cannot add '%s'. Node name collision: '%s' already declared at %s",
                value.getRoot().rawArgument(), key, prev.argument(), prev.sourceReference());
        }
    }

    private static , E extends SchemaTreeEffectiveStatement>
            StmtContext requestFrom(final NamespaceStorage storage, final QName key) {
        return storage instanceof OnDemandSchemaTreeStorage ondemand ? ondemand.requestSchemaTreeChild(key) : null;
    }

    private static NamespaceStorage globalOrStatementSpecific(final NamespaceStorage storage) {
        var current = storage;
        while (true) {
            if (current.getStorageType() == StorageType.STATEMENT_LOCAL) {
                return current;
            }

            final var parent = current.getParentStorage();
            if (parent == null) {
                // Implies StorageType.GLOBAL
                return current;
            }
            current = parent;
        }
    }
}