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

Interface Controller

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Controller>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Controllers>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<ControllerKey>, OpenflowConnectionsTop
    @Generated("mdsal-binding-generator")
public interface Controller
extends org.opendaylight.yangtools.yang.binding.ChildOf<Controllers>, org.opendaylight.yangtools.yang.binding.Augmentable<Controller>, OpenflowConnectionsTop, org.opendaylight.yangtools.yang.binding.Identifiable<ControllerKey>
    The Openflow Switch connects to all Openflow controllers configured

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

     list controller {
   key name;
   leaf name {
     type leafref {
       path ../config/name;
     }
   }
   container config {
     uses openflow-controller-config;
   }
   container state {
     config false;
     uses openflow-controller-config;
     uses openflow-controller-state;
   }
   uses openflow-connections-top;
 }
    The schema path to identify an instance is openconfig-openflowopenflow-controllers-topcontrollerscontroller

    To create instances of this class use ControllerBuilder.

    See Also:
    ControllerBuilder, ControllerKey

    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME

    • Method Detail

      • implementedInterface

        default Class<Controller> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
        Specified by:
        implementedInterface in interface OpenflowConnectionsTop

      • bindingHashCode

        static int bindingHashCode​(@NonNull Controller 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 Controller 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 Controller 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

      • getName

        String getName()
        Return name, or null if it is not present. 
             
         The name identifies the controller.
        Returns:
        String name, or null if it is not present.

      • requireName

        default @NonNull String requireName()
        Return name, guaranteed to be non-null. 
             
         The name identifies the controller.
        Returns:
        String name, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if name is not present

      • getConfig

        Config getConfig()
        Return config, or null if it is not present. 
             
         Container for the Openflow controller config.
        Returns:
        Config config, or null if it is not present.

      • getState

        State getState()
        Return state, or null if it is not present. 
             
         Container for the Openflow controller state.
        Returns:
        State state, or null if it is not present.