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

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. 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;
   9
  10 import java.util.Collection;
  11 import org.eclipse.jdt.annotation.NonNull;
  12 import org.opendaylight.yangtools.yang.model.api.stmt.IdentityEffectiveStatement;
  13
  14 /**
  15  * Interface describing YANG 'identity' statement.
  16  *
  17  * <p>
  18  * The 'identity' statement is used to define a new globally unique, abstract, and untyped identity. Its only purpose
  19  * is to denote its name, semantics, and existence. The built-in datatype "identityref" can be used to reference
  20  * identities within a data model.
  21  */
  22 public interface IdentitySchemaNode extends SchemaNode, EffectiveStatementEquivalent<IdentityEffectiveStatement> {
  23     /**
  24      * Return base identities of this identity. The semantics of differ between RFC6020 and RFC7950 here. YANG 1.0
  25      * uses single inheritance, where there can be 0..1 base identities. YANG 1.1 uses multiple inheritance, where
  26      * there can be 0..N base identities.
  27      *
  28      * <p>
  29      * Callers should be prepared to handle multiple base identities.
  30      *
  31      * @return set of existing identities from which the new identity is derived or an empty Set if the identity is
  32      *         a root identity.
  33      */
  34     @NonNull Collection<? extends @NonNull IdentitySchemaNode> getBaseIdentities();
  35 }