Package org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.ospf.node.attributes

Interface OspfNodeAttributes

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

    This class represents the following YANG schema fragment defined in module ospf-topology 

     container ospf-node-attributes {
   choice router-type {
     case abr {
       leaf abr {
         type empty;
       }
     }
     case asbr {
       leaf asbr {
         type empty;
       }
     }
     case internal {
       leaf internal {
         type empty;
       }
     }
     case pseudonode {
       leaf pseudonode {
         type empty;
       }
     }
   }
   leaf dr-interface-id {
     when ../router-type/pseudonode;
     default 0;
     type uint32;
   }
   leaf-list multi-topology-id {
     max-elements 128;
     type uint8 {
       range 0..127;
     }
   }
   leaf capabilities {
     type bits {
       bit graceful-restart-capable {
         position 0;
       }
       bit graceful-restart-helper {
         position 1;
       }
       bit stub-router-support {
         position 2;
       }
       bit traffic-engineering-support {
         position 3;
       }
       bit point-to-point-over-lan {
         position 4;
       }
       bit experimental-te {
         position 5;
       }
     }
   }
   container ted {
     uses ted:ted-node-attributes;
   }
 }
    The schema path to identify an instance is ospf-topologyospf-node-attributesospf-node-attributes

    To create instances of this class use OspfNodeAttributesBuilder.

    See Also:
    OspfNodeAttributesBuilder

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

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

      • getRouterType

        RouterType getRouterType()
        Return routerType, or null if it is not present.
        Returns:
        RouterType routerType, or null if it is not present.

      • getDrInterfaceId

        org.opendaylight.yangtools.yang.common.Uint32 getDrInterfaceId()
        Return drInterfaceId, or null if it is not present. 
             
         For pseudonodes, DR interface-id
        Returns:
        Uint32 drInterfaceId, or null if it is not present.

      • requireDrInterfaceId

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireDrInterfaceId()
        Return drInterfaceId, guaranteed to be non-null. 
             
         For pseudonodes, DR interface-id
        Returns:
        Uint32 drInterfaceId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if drInterfaceId is not present

      • getMultiTopologyId

        @Nullable List<org.opendaylight.yangtools.yang.common.Uint8> getMultiTopologyId()
        Return multiTopologyId, or null if it is not present. 
             
         List of Multi-Topology Identifier up-to 128 (0-127). RFC 4915
        Returns:
        List<Uint8> multiTopologyId, or null if it is not present.

      • requireMultiTopologyId

        default @NonNull List<org.opendaylight.yangtools.yang.common.Uint8> requireMultiTopologyId()
        Return multiTopologyId, guaranteed to be non-null. 
             
         List of Multi-Topology Identifier up-to 128 (0-127). RFC 4915
        Returns:
        List<Uint8> multiTopologyId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if multiTopologyId is not present

      • getCapabilities

        OspfNodeAttributes.Capabilities getCapabilities()
        Return capabilities, or null if it is not present. 
             
         OSPF capabilities as bit vector. RFC 4970
        Returns:
        Capabilities capabilities, or null if it is not present.

      • requireCapabilities

        default @NonNull OspfNodeAttributes.Capabilities requireCapabilities()
        Return capabilities, guaranteed to be non-null. 
             
         OSPF capabilities as bit vector. RFC 4970
        Returns:
        Capabilities capabilities, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if capabilities is not present

      • getTed

        Ted getTed()
        Return ted, or null if it is not present.
        Returns:
        Ted ted, or null if it is not present.