Interface PathDescription

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<PathDescription>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<PathDescriptions>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, SrDescription

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

    This class represents the following YANG schema fragment defined in module path-computation

     list path-description {
       leaf ipv4 {
         when "path-constraints/address-family = 0";
         type inet:ipv4-address;
       }
       leaf ipv6 {
         when "path-constraints/address-family = 1";
         type inet:ipv6-address;
       }
       uses sr-description;
     }
     
    The schema path to identify an instance is path-computationpath-descriptionspath-description

    To create instances of this class use PathDescriptionBuilder.

    See Also:
    PathDescriptionBuilder
    • Field Detail

      • QNAME

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

      • implementedInterface

        default Class<PathDescription> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
        Specified by:
        implementedInterface in interface SrDescription
      • bindingHashCode

        static int bindingHashCode​(@NonNull PathDescription 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 PathDescription 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 PathDescription 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
      • getIpv4

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getIpv4()
        Return ipv4, or null if it is not present.
        Returns:
        Ipv4Address ipv4, or null if it is not present.
      • requireIpv4

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

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address getIpv6()
        Return ipv6, or null if it is not present.
        Returns:
        Ipv6Address ipv6, or null if it is not present.
      • requireIpv6

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