Package org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.service.path

Interface ServicePath

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

    This class represents the following YANG schema fragment defined in module ietf-lisp-address-types 

     container service-path {
   when "../address-type = 'laddr:service-path-lcaf'" {
   }
   leaf service-path-id {
     type service-path-id-type;
   }
   leaf service-index {
     type uint8;
   }
 }

    To create instances of this class use ServicePathBuilder.

    See Also:
    ServicePathBuilder

    • 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 java.lang.Class<ServicePath> 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 ServicePath 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:
        java.lang.NullPointerException - if obj is null

      • bindingEquals

        static boolean bindingEquals​(@NonNull ServicePath thisObj,
                             java.lang.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:
        java.lang.NullPointerException - if thisObj is null

      • bindingToString

        static java.lang.String bindingToString​(@NonNull ServicePath 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:
        java.lang.NullPointerException - if obj is null

      • getServicePathId

        ServicePathIdType getServicePathId()
        Return servicePathId, or null if it is not present. 
             
         Service path identifier for the path for NSH header
        Returns:
        ServicePathIdType servicePathId, or null if it is not present.

      • requireServicePathId

        default @NonNull ServicePathIdType requireServicePathId()
        Return servicePathId, guaranteed to be non-null. 
             
         Service path identifier for the path for NSH header
        Returns:
        ServicePathIdType servicePathId, guaranteed to be non-null.
        Throws:
        java.util.NoSuchElementException - if servicePathId is not present

      • getServiceIndex

        org.opendaylight.yangtools.yang.common.Uint8 getServiceIndex()
        Return serviceIndex, or null if it is not present. 
             
         Service path index for NSH header
        Returns:
        Uint8 serviceIndex, or null if it is not present.

      • requireServiceIndex

        default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requireServiceIndex()
        Return serviceIndex, guaranteed to be non-null. 
             
         Service path index for NSH header
        Returns:
        Uint8 serviceIndex, guaranteed to be non-null.
        Throws:
        java.util.NoSuchElementException - if serviceIndex is not present