Interface Prefixes

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

    @Generated("mdsal-binding-generator")
    public interface Prefixes
    extends org.opendaylight.yangtools.yang.binding.ChildOf<PrefixList>, org.opendaylight.yangtools.yang.binding.Augmentable<Prefixes>

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

     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/prefix-list/prefixes

    To create instances of this class use PrefixesBuilder.

    See Also:
    PrefixesBuilder
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME  
    • Field Detail

      • QNAME

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

      • implementedInterface

        default java.lang.Class<Prefixes> 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 Prefixes 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 Prefixes 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 Prefixes 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
      • getPrefix

        @Nullable java.util.Map<PrefixKey,​Prefix> getPrefix()
        Return prefix, or null if it is not present.
             
                 A prefix is a rule with a BGP filter. The left hand side of the rule is the
                 prefix filter. It specifies a set of IP addresses. If a BGP announcement
                 contains an address that matches, the rule is applied. The right hand side of
                 the rule specifies the action that is to be applied.
             
         
        Returns:
        java.util.Map prefix, or null if it is not present.
      • nonnullPrefix

        default @NonNull java.util.Map<PrefixKey,​Prefix> nonnullPrefix()
        Return prefix, or an empty list if it is not present.
        Returns:
        java.util.Map prefix, or an empty list if it is not present.