Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance

Interface Protocols

All Superinterfaces:
org.opendaylight.yangtools.binding.Augmentable<Protocols>, org.opendaylight.yangtools.binding.BindingContract<org.opendaylight.yangtools.binding.DataContainer>, org.opendaylight.yangtools.binding.BindingObject, org.opendaylight.yangtools.binding.ChildOf<NetworkInstance>, org.opendaylight.yangtools.binding.DataContainer, org.opendaylight.yangtools.binding.DataObject
@Generated("mdsal-binding-generator") public interface Protocols extends org.opendaylight.yangtools.binding.ChildOf<NetworkInstance>, org.opendaylight.yangtools.binding.Augmentable<Protocols>
The routing protocols that are enabled for this network-instance.

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

 container protocols {
   list protocol {
     key "identifier name";
     leaf identifier {
       type leafref {
         path ../config/identifier;
       }
     }
     leaf name {
       type leafref {
         path ../config/name;
       }
     }
     container config {
       uses protocols-config;
     }
     container state {
       config false;
       uses protocols-config;
       uses protocols-state;
     }
     container static {
       when "../config/identifier = 'STATIC'" {
       }
       uses lroute:local-static-top;
     }
     container aggregate {
       when "../config/identifier = 'LOCAL-AGGREGATE'" {
       }
       uses lroute:local-aggregate-top;
     }
   }
 }

To create instances of this class use ProtocolsBuilder.

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<Protocols> implementedInterface()
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.binding.BindingContract<org.opendaylight.yangtools.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.binding.DataObject

    • bindingHashCode

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

    • getProtocol

      @Nullable Map<ProtocolKey,Protocol> getProtocol()
      Return protocol, or null if it is not present. 
           
         A process (instance) of a routing protocol. Some systems may not support more
         than one instance of a particular routing protocol
      Returns:
      Map<ProtocolKey, Protocol> protocol, or null if it is not present.

    • nonnullProtocol

      default @NonNull Map<ProtocolKey,Protocol> nonnullProtocol()
      Return protocol, or an empty list if it is not present.
      Returns:
      Map<ProtocolKey, Protocol> protocol, or an empty list if it is not present.