Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.routes

Interface LinkstateRoutes

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<LinkstateRoutes>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<LinkstateRoutes>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    @Generated("mdsal-binding-generator")
public interface LinkstateRoutes
extends org.opendaylight.yangtools.yang.binding.ChildOf<LinkstateRoutes>, org.opendaylight.yangtools.yang.binding.Augmentable<LinkstateRoutes>

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

     container linkstate-routes {
   list linkstate-route {
     key "route-key path-id";
     uses linkstate;
     uses bgp-rib:route {
       augment attributes {
         uses linkstate-path-attribute;
       }
     }
   }
 }

    To create instances of this class use LinkstateRoutesBuilder.

    See Also:
    LinkstateRoutesBuilder

    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
        YANG identifier of the statement represented by this class.

    • Method Detail

      • implementedInterface

        default Class<LinkstateRoutes> 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 LinkstateRoutes 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 LinkstateRoutes 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 LinkstateRoutes 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

      • getLinkstateRoute

        @Nullable Map<LinkstateRouteKey,​LinkstateRoute> getLinkstateRoute()
        Return linkstateRoute, or null if it is not present. 
             
         Link-state information entry. Due to the complexity of link-state information
         and YANG limitations this is the top-level object from contract perspective. It
         is keyed by route-key, whose format is internal to the implementation exposing
         this information. As an explicit example it can rely on information stored in
         the entry's subtree, so the subtree MUST NOT be modified by outside entities.
         Augmentations can attach data, but must be explicitly aware that such data,
         unlike the data modeled directly here, does not have any effects on keys,
         especially they must not impact equality tests.
        Returns:
        Map<LinkstateRouteKey, LinkstateRoute> linkstateRoute, or null if it is not present.

      • nonnullLinkstateRoute

        default @NonNull Map<LinkstateRouteKey,​LinkstateRoute> nonnullLinkstateRoute()
        Return linkstateRoute, or an empty list if it is not present.
        Returns:
        Map<LinkstateRouteKey, LinkstateRoute> linkstateRoute, or an empty list if it is not present.