yang/rfc7952-model-api/src/main/java/org/opendaylight/yangtools/rfc7952/model/api/AnnotationSchemaNodeAware.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.rfc7952.model.api;
   9
  10 import com.google.common.annotations.Beta;
  11 import java.util.Optional;
  12 import org.eclipse.jdt.annotation.NonNull;
  13 import org.opendaylight.yangtools.yang.common.QName;
  14
  15 /**
  16  * Interface for entities which can lookup {@link AnnotationSchemaNode}s based on their name.
  17  *
  18  * @author Robert Varga
  19  */
  20 @Beta
  21 public interface AnnotationSchemaNodeAware {
  22     /**
  23      * Find an annotation based on its QName.
  24      *
  25      * @param qname Annotation name
  26      * @return AnnotationSchemaNode if found
  27      * @throws NullPointerException if {@code qname} is null
  28      */
  29     @NonNull Optional<AnnotationSchemaNode> findAnnotation(QName qname);
  30 }