Package org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819

Interface NodeContextRef

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
All Known Subinterfaces:
AddBundleMessagesInput, AddFlowInput, AddFlowsBatchInput, AddGroupInput, AddGroupsBatchInput, AddMeterInput, AddMetersBatchInput, BulkFlowBaseContentGrouping, BulkFlowDsItem, BulkFlowItem, BundleInnerMessageGrouping, CommitActiveBundleInput, ControlBundleInput, ExperimenterMessageFromDev, ExperimenterSymmetricMessage, FlowAdded, FlowRemoved, FlowUpdate, FlowUpdated, GetActiveBundleInput, GetAggregateFlowStatisticsFromFlowTableForAllFlowsInput, GetAggregateFlowStatisticsFromFlowTableForGivenMatchInput, GetAllFlowsStatisticsFromAllFlowTablesInput, GetAllFlowStatisticsFromFlowTableInput, GetAllGroupStatisticsInput, GetAllMeterConfigStatisticsInput, GetAllMeterStatisticsInput, GetAllNodeConnectorsStatisticsInput, GetAllQueuesStatisticsFromAllPortsInput, GetAllQueuesStatisticsFromGivenPortInput, GetAsyncInput, GetFlowStatisticsFromFlowTableInput, GetFlowStatisticsInput, GetFlowTablesStatisticsInput, GetGroupDescriptionInput, GetGroupFeaturesInput, GetGroupStatisticsInput, GetGroupStatisticsInput, GetMeterFeaturesInput, GetMeterStatisticsInput, GetMeterStatisticsInput, GetNodeConnectorStatisticsInput, GetNodeConnectorStatisticsInput, GetQueueInput, GetQueueStatisticsFromGivenPortInput, GetQueueStatisticsInput, GroupUpdate, Message, MeterUpdate, NodeFlow, NodeGroup, NodeMeter, NodeQueue, PortUpdate, ProcessFlatBatchInput, ReconcileNodeInput, RemoveFlowInput, RemoveFlowsBatchInput, RemoveGroupInput, RemoveGroupsBatchInput, RemoveMeterInput, RemoveMetersBatchInput, SalAddMessageData, SendEchoInput, SendExperimenterInput, SendExperimenterMpRequestInput, SetAsyncInput, SetConfigInput, SetRoleInput, StatsInputCommonGrouping, TableUpdate, TableUpdated, TransmitPacketInput, UpdateFlowInput, UpdateFlowsBatchInput, UpdateGroupInput, UpdateGroupsBatchInput, UpdateMeterInput, UpdateMetersBatchInput, UpdatePortInput, UpdateTableInput
@Generated("mdsal-binding-generator") public interface NodeContextRef extends org.opendaylight.yangtools.yang.binding.DataObject
A helper grouping which contains a reference to a node classified with a node-context. This allows RPCs in other YANG files to refine their input to a particular node instance.

This class represents the following YANG schema fragment defined in module opendaylight-inventory 

 grouping node-context-ref {
   leaf node {
     ext:context-reference node-context;
     type node-ref;
   }
 }

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final @NonNull org.opendaylight.yangtools.yang.common.QName
    QNAME
    YANG identifier of the statement represented by this class.

  • Method Summary

    Modifier and Type
    Method
    Description
    NodeRef
    getNode()
    Return node, or null if it is not present.
    Class<? extends NodeContextRef>
    implementedInterface()
     
    default @NonNull NodeRef
    requireNode()
    Return node, guaranteed to be non-null.

  • Field Details

    • QNAME

      static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
      YANG identifier of the statement represented by this class.

  • Method Details

    • implementedInterface

      Class<? extends NodeContextRef> implementedInterface()
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

    • getNode

      @RoutingContext(NodeContext.class) NodeRef getNode()
      Return node, or null if it is not present. 
           
         A reference to a particular node.
      Returns:
      NodeRef node, or null if it is not present.

    • requireNode

      default @NonNull NodeRef requireNode()
      Return node, guaranteed to be non-null. 
           
         A reference to a particular node.
      Returns:
      NodeRef node, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if node is not present