opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/IdentitySchemaNode.java

   1 /*\r
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
   3  *\r
   4  * This program and the accompanying materials are made available under the\r
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html\r
   7  */\r
   8 package org.opendaylight.controller.yang.model.api;\r
   9 \r
  10 /**\r
  11  * Interface describing YANG 'identity' statement.\r
  12  * <p>\r
  13  * The 'identity' statement is used to define a new globally unique, abstract,\r
  14  * and untyped identity. Its only purpose is to denote its name, semantics, and\r
  15  * existence. The built-in datatype "identityref" can be used to reference\r
  16  * identities within a data model.\r
  17  * </p>\r
  18  */\r
  19 public interface IdentitySchemaNode extends SchemaNode {\r
  20 \r
  21     /**\r
  22      * @return an existing identity, from which the new identity is derived or\r
  23      *         null, if the identity is defined from scratch.\r
  24      */\r
  25     IdentitySchemaNode getBaseIdentity();\r
  26 \r
  27 }\r