org.opendaylight.yangtools.rfc7952.model.api.AnnotationSchemaNode Maven / Gradle / Ivy

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) 2017 Pantheon Technologies 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.rfc7952.model.api;

import com.google.common.annotations.Beta;
import com.google.common.collect.ImmutableMap;
import java.util.Map;
import java.util.Optional;
import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.yangtools.yang.common.AnnotationName;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.model.api.SchemaContext;
import org.opendaylight.yangtools.yang.model.api.TypeAware;
import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;

/**
 * Represents the effect of 'annotation' extension, as defined in
 * RFC7952, being attached to a SchemaNode.
 */
@Beta
public interface AnnotationSchemaNode extends UnknownSchemaNode, TypeAware {
    /**
     * Find specified annotation if it is supported by the specified SchemaContext.
     *
     * @param context SchemaContext to search
     * @param name Annotation name
     * @return {@link AnnotationSchemaNode} corresponding to specified name, or empty if it is not supported
     *         by the SchemaContext..
     * @throws NullPointerException if any of the arguments is null
     */
    static @NonNull Optional find(final SchemaContext context, final AnnotationName name) {
        if (context instanceof AnnotationSchemaNodeAware aware) {
            return aware.findAnnotation(name);
        }

        return context.findModule(name.qname().getModule())
            .flatMap(module -> module.getUnknownSchemaNodes().stream()
                .filter(AnnotationSchemaNode.class::isInstance)
                .map(AnnotationSchemaNode.class::cast)
                .filter(annotation -> name.equals(annotation.name()))
                .findAny());
    }

    /**
     * Find all annotations supported by a SchemaContext.
     *
     * @param context SchemaContext to search
     * @return {@link AnnotationSchemaNode}s supported by the SchemaContext..
     * @throws NullPointerException if context is null
     */
    static @NonNull Map findAll(final SchemaContext context) {
        final var builder = ImmutableMap.builder();
        for (var module : context.getModules()) {
            for (var node : module.getUnknownSchemaNodes()) {
                if (node instanceof AnnotationSchemaNode annotation) {
                    builder.put(annotation.name(), annotation);
                }
            }
        }
        return builder.build();
    }

    default @NonNull AnnotationName name() {
        return asEffectiveStatement().argument();
    }

    @Override
    default QName getQName() {
        return name().qname();
    }

    @Override
    AnnotationEffectiveStatement asEffectiveStatement();
}