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

Interface LinkstateRoute

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<LinkstateRoute>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, 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, org.opendaylight.yangtools.yang.binding.KeyAware<LinkstateRouteKey>, Linkstate, PathAttributes, PathIdGrouping, Route, RouteDistinguisherGrouping
@Generated("mdsal-binding-generator") public interface LinkstateRoute extends org.opendaylight.yangtools.yang.binding.ChildOf<LinkstateRoutes>, org.opendaylight.yangtools.yang.binding.Augmentable<LinkstateRoute>, Linkstate, Route, org.opendaylight.yangtools.yang.binding.KeyAware<LinkstateRouteKey>
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.

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

 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 LinkstateRouteBuilder.

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<LinkstateRoute> implementedInterface()
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      Specified by:
      implementedInterface in interface Linkstate
      Specified by:
      implementedInterface in interface PathAttributes
      Specified by:
      implementedInterface in interface PathIdGrouping
      Specified by:
      implementedInterface in interface Route
      Specified by:
      implementedInterface in interface RouteDistinguisherGrouping

    • bindingHashCode

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

      LinkstateRouteKey key()
      Specified by:
      key in interface org.opendaylight.yangtools.yang.binding.KeyAware<LinkstateRouteKey>