Interface PrefixLists

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<PrefixLists>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<BgpData>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

    @Generated("mdsal-binding-generator")
    public interface PrefixLists
    extends org.opendaylight.yangtools.yang.binding.ChildOf<BgpData>, org.opendaylight.yangtools.yang.binding.Augmentable<PrefixLists>
    Contains all prefix lists defined on a router.

    This class represents the following YANG schema fragment defined in module bgp

     container prefix-lists {
       list prefix-list {
         key prefix-list-name;
         leaf prefix-list-name {
           type string;
         }
         container prefixes {
           list prefix {
             key seq-nr;
             leaf seq-nr {
               type uint16;
             }
             container prefix-filter {
               choice ip-address-group {
                 case ip-address {
                   leaf ip-address {
                     type inet:ip-address;
                   }
                 }
                 case prefix {
                   leaf prefix {
                     type inet:ip-prefix;
                   }
                 }
                 case host {
                   leaf ip-host-address {
                     type inet:host;
                   }
                 }
                 case ip-range {
                   leaf lower {
                     type inet:ip-address;
                   }
                   leaf upper {
                     type inet:ip-address;
                   }
                 }
               }
               leaf action {
                 type actions-enum;
               }
               container statistics {
                 leaf prefix-hit-count {
                   type uint32;
                   config false;
                 }
               }
             }
           }
         }
       }
     }
     
    The schema path to identify an instance is bgp/prefix-lists

    To create instances of this class use PrefixListsBuilder.

    See Also:
    PrefixListsBuilder
    • Field Detail

      • QNAME

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

      • implementedInterface

        default java.lang.Class<PrefixLists> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      • bindingHashCode

        static int bindingHashCode​(@NonNull PrefixLists 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:
        java.lang.NullPointerException - if obj is null
      • bindingEquals

        static boolean bindingEquals​(@NonNull PrefixLists thisObj,
                                     java.lang.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:
        java.lang.NullPointerException - if thisObj is null
      • bindingToString

        static java.lang.String bindingToString​(@NonNull PrefixLists 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:
        java.lang.NullPointerException - if obj is null
      • getPrefixList

        @Nullable java.util.Map<PrefixListKey,​PrefixList> getPrefixList()
        Return prefixList, or null if it is not present.
             
                 A prefix list.
             
         
        Returns:
        java.util.Map prefixList, or null if it is not present.
      • nonnullPrefixList

        default @NonNull java.util.Map<PrefixListKey,​PrefixList> nonnullPrefixList()
        Return prefixList, or an empty list if it is not present.
        Returns:
        java.util.Map prefixList, or an empty list if it is not present.