Interface Ipv4Route

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Ipv4Route>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Ipv4Routes>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<Ipv4RouteKey>, PathAttributes, PathIdGrouping, Route

    @Generated("mdsal-binding-generator")
    public interface Ipv4Route
    extends org.opendaylight.yangtools.yang.binding.ChildOf<Ipv4Routes>, org.opendaylight.yangtools.yang.binding.Augmentable<Ipv4Route>, Route, org.opendaylight.yangtools.yang.binding.Identifiable<Ipv4RouteKey>

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

     list ipv4-route {
       key "route-key path-id";
       uses bgp-rib:route;
       leaf prefix {
         type inet:ipv4-prefix;
       }
     }
     
    The schema path to identify an instance is bgp-inetipv4-routesipv4-routesipv4-route

    To create instances of this class use Ipv4RouteBuilder.

    See Also:
    Ipv4RouteBuilder, Ipv4RouteKey
    • Field Detail

      • QNAME

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

      • bindingHashCode

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

        Ipv4RouteKey key()
        Specified by:
        key in interface org.opendaylight.yangtools.yang.binding.Identifiable<Ipv4RouteKey>
      • getPrefix

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix getPrefix()
        Return prefix, or null if it is not present.
        Returns:
        Ipv4Prefix prefix, or null if it is not present.
      • requirePrefix

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix requirePrefix()
        Return prefix, guaranteed to be non-null.
        Returns:
        Ipv4Prefix prefix, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if prefix is not present