model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/KeyEffectiveStatement.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies, 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.yang.model.api.stmt;
   9
  10 import java.util.Set;
  11 import org.opendaylight.yangtools.yang.common.QName;
  12 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  13 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  14 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  15
  16 /**
  17  * Effective representation of a {@code key} statement.
  18  */
  19 public interface KeyEffectiveStatement extends EffectiveStatement<Set<QName>, KeyStatement> {
  20     @Override
  21     default  StatementDefinition statementDefinition() {
  22         return YangStmtMapping.KEY;
  23     }
  24
  25     /**
  26      * {@inheritDoc}
  27      *
  28      * <p>
  29      * Iteration order of the returned set is required to match the order in which key components were declared.
  30      */
  31     @Override
  32     Set<QName> argument();
  33 }