Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.openflow.rev181121.openflow.connections.top.connections

Interface Connection

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<Connection>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Connections>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.KeyAware<ConnectionKey>
@Generated("mdsal-binding-generator") public interface Connection extends org.opendaylight.yangtools.yang.binding.ChildOf<Connections>, org.opendaylight.yangtools.yang.binding.Augmentable<Connection>, org.opendaylight.yangtools.yang.binding.KeyAware<ConnectionKey>
List of connections to the OpenFlow controller. The Openflow switch always connects to configured Openflow controllers. Each controller can have more than one connection, called auxiliary Openflow connections.

This class represents the following YANG schema fragment defined in module openconfig-openflow 

 list connection {
   key aux-id;
   leaf aux-id {
     type leafref {
       path ../config/aux-id;
     }
   }
   container config {
     uses openflow-connections-config;
   }
   container state {
     config false;
     uses openflow-connections-config;
     uses openflow-connections-state;
   }
 }

To create instances of this class use ConnectionBuilder.

See Also:

  • 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

      default Class<Connection> 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

    • bindingHashCode

      static int bindingHashCode(@NonNull Connection obj)
      Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
      Parameters:
      obj - Object for which to generate hashCode() result.
      Returns:
      Hash code value of data modeled by this interface.
      Throws:
      NullPointerException - if obj is null

    • bindingEquals

      static boolean bindingEquals(@NonNull Connection thisObj, Object obj)
      Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
      Parameters:
      thisObj - Object acting as the receiver of equals invocation
      obj - Object acting as argument to equals invocation
      Returns:
      True if thisObj and obj are considered equal
      Throws:
      NullPointerException - if thisObj is null

    • bindingToString

      static String bindingToString(@NonNull Connection obj)
      Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
      Parameters:
      obj - Object for which to generate toString() result.
      Returns:
      String value of data modeled by this interface.
      Throws:
      NullPointerException - if obj is null

    • key

      ConnectionKey key()
      Specified by:
      key in interface org.opendaylight.yangtools.yang.binding.KeyAware<ConnectionKey>

    • getAuxId

      AuxiliaryId getAuxId()
      Return auxId, or null if it is not present. 
           
         Reference to auxiliary id list key
      Returns:
      AuxiliaryId auxId, or null if it is not present.

    • requireAuxId

      default @NonNull AuxiliaryId requireAuxId()
      Return auxId, guaranteed to be non-null. 
           
         Reference to auxiliary id list key
      Returns:
      AuxiliaryId auxId, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if auxId is not present

    • getConfig

      Config getConfig()
      Return config, or null if it is not present. 
           
         Configuration data for OpenFlow controller connections
      Returns:
      Config config, or null if it is not present.

    • nonnullConfig

      @NonNull Config nonnullConfig()
      Return config, or an empty instance if it is not present.
      Returns:
      Config config, or an empty instance if it is not present.

    • getState

      State getState()
      Return state, or null if it is not present. 
           
         Operational state data for OpenFlow controller connections
      Returns:
      State state, or null if it is not present.

    • nonnullState

      @NonNull State nonnullState()
      Return state, or an empty instance if it is not present.
      Returns:
      State state, or an empty instance if it is not present.