yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/IdentityrefTypeDefinition.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.type;
   9
  10 import java.util.Set;
  11 import javax.annotation.Nonnull;
  12 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
  13 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  14
  15 /**
  16  * Contains method for getting data from <code>identityref</code> built-in YANG
  17  * type.
  18  */
  19 public interface IdentityrefTypeDefinition extends TypeDefinition<IdentityrefTypeDefinition> {
  20     /**
  21      * Returns identity to which the instance of this type refers.
  22      *
  23      * @deprecated use {@link #getIdentities()} instead
  24      *
  25      * @return identity which is specified with the <code>identity</code> YANG
  26      *         statement
  27      */
  28     @Deprecated
  29     IdentitySchemaNode getIdentity();
  30
  31     /**
  32      * Returns the set of identities this reference points to.
  33      *
  34      * @return set of identities to which the instance of this type refers (in YANG 1.1 models) or a set containing
  35      *         just one identity (in YANG 1.0 models)
  36      */
  37     @Nonnull Set<IdentitySchemaNode> getIdentities();
  38 }