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

Interface Hop

All Superinterfaces:

org.opendaylight.yangtools.yang.binding.Augmentable<Hop>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<ExplicitLocatorPath>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<HopKey>

@Generated("mdsal-binding-generator")
public interface Hop
extends org.opendaylight.yangtools.yang.binding.ChildOf<ExplicitLocatorPath>, org.opendaylight.yangtools.yang.binding.Augmentable<Hop>, org.opendaylight.yangtools.yang.binding.Identifiable<HopKey>

List of locator hops forming the explicit path.

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

 list hop {
   key hop-id;
   ordered-by user;
   leaf hop-id {
     type string;
   }
   leaf address {
     type simple-address;
   }
   leaf lrs-bits {
     type bits {
       bit lookup {
       }
       bit rloc-probe {
       }
       bit strict {
       }
     }
   }
 }
 

To create instances of this class use HopBuilder.

See Also:

• HopBuilder
• HopKey

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	Hop.LrsBits	This class represents the following YANG schema fragment defined in module ietf-lisp-address-types

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static boolean	bindingEquals(@NonNull Hop thisObj, Object obj)	Default implementation of Object.equals(Object) contract for this interface.
static int	bindingHashCode(@NonNull Hop obj)	Default implementation of Object.hashCode() contract for this interface.
static String	bindingToString(@NonNull Hop obj)	Default implementation of Object.toString() contract for this interface.
SimpleAddress	getAddress()	Return address, or null if it is not present.
String	getHopId()	Return hopId, or null if it is not present.
Hop.LrsBits	getLrsBits()	Return lrsBits, or null if it is not present.
default Class<Hop>	implementedInterface()
HopKey	key()
default @NonNull SimpleAddress	requireAddress()	Return address, guaranteed to be non-null.
default @NonNull String	requireHopId()	Return hopId, guaranteed to be non-null.
default @NonNull Hop.LrsBits	requireLrsBits()	Return lrsBits, guaranteed to be non-null.

Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

augmentation, augmentationOrElseThrow, augmentationOrElseThrow, augmentations

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<Hop> 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

bindingHashCode

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

HopKey key()

Specified by:

key in interface org.opendaylight.yangtools.yang.binding.Identifiable<HopKey>

getHopId

String getHopId()

Return hopId, or null if it is not present.

     
         Unique identifier for the hop.
     
 

Returns:

String hopId, or null if it is not present.

requireHopId

default @NonNull String requireHopId()

Return hopId, guaranteed to be non-null.

     
         Unique identifier for the hop.
     
 

Returns:

String hopId, guaranteed to be non-null.

Throws:

NoSuchElementException - if hopId is not present

getAddress

SimpleAddress getAddress()

Return address, or null if it is not present.

     
         AFI address.
     
 

Returns:

SimpleAddress address, or null if it is not present.

requireAddress

default @NonNull SimpleAddress requireAddress()

Return address, guaranteed to be non-null.

     
         AFI address.
     
 

Returns:

SimpleAddress address, guaranteed to be non-null.

Throws:

NoSuchElementException - if address is not present

getLrsBits

Hop.LrsBits getLrsBits()

Return lrsBits, or null if it is not present.

     
         Flag bits per hop.
     
 

Returns:

LrsBits lrsBits, or null if it is not present.

requireLrsBits

default @NonNull Hop.LrsBits requireLrsBits()

Return lrsBits, guaranteed to be non-null.

     
         Flag bits per hop.
     
 

Returns:

LrsBits lrsBits, guaranteed to be non-null.

Throws:

NoSuchElementException - if lrsBits is not present