Interface MappingRecord

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<MappingRecord>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<MappingRecordContainer>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, EidContainer, LocatorRecords, MappingRecordMetadata

    @Generated("mdsal-binding-generator")
    public interface MappingRecord
    extends org.opendaylight.yangtools.yang.binding.ChildOf<MappingRecordContainer>, org.opendaylight.yangtools.yang.binding.Augmentable<MappingRecord>, EidContainer, LocatorRecords, MappingRecordMetadata

    This class represents the following YANG schema fragment defined in module odl-lisp-proto

     container mapping-record {
       leaf recordTtl {
         type int32;
       }
       leaf mapVersion {
         type int16;
       }
       leaf action {
         type enumeration {
           enum NoAction;
           enum NativelyForward;
           enum SendMapRequest;
           enum Drop;
         }
       }
       leaf authoritative {
         type boolean;
       }
       uses eid-container;
       uses LocatorRecords;
       uses mapping-record-metadata;
     }
     

    To create instances of this class use MappingRecordBuilder.

    See Also:
    MappingRecordBuilder
    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
        YANG identifier of the statement represented by this class.
    • Method Detail

      • bindingHashCode

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

        java.lang.Integer getRecordTtl()
        Return recordTtl, or null if it is not present.
             
                 A mapping record's time to live in Minute(s)
             
         
        Returns:
        Integer recordTtl, or null if it is not present.
      • requireRecordTtl

        default @NonNull java.lang.Integer requireRecordTtl()
        Return recordTtl, guaranteed to be non-null.
             
                 A mapping record's time to live in Minute(s)
             
         
        Returns:
        Integer recordTtl, guaranteed to be non-null.
        Throws:
        java.util.NoSuchElementException - if recordTtl is not present
      • getMapVersion

        java.lang.Short getMapVersion()
        Return mapVersion, or null if it is not present.
        Returns:
        Short mapVersion, or null if it is not present.
      • requireMapVersion

        default @NonNull java.lang.Short requireMapVersion()
        Return mapVersion, guaranteed to be non-null.
        Returns:
        Short mapVersion, guaranteed to be non-null.
        Throws:
        java.util.NoSuchElementException - if mapVersion is not present
      • getAction

        MappingRecord.Action getAction()
        Return action, or null if it is not present.
        Returns:
        Action action, or null if it is not present.
      • requireAction

        default @NonNull MappingRecord.Action requireAction()
        Return action, guaranteed to be non-null.
        Returns:
        Action action, guaranteed to be non-null.
        Throws:
        java.util.NoSuchElementException - if action is not present
      • getAuthoritative

        java.lang.Boolean getAuthoritative()
        Return authoritative, or null if it is not present.
        Returns:
        Boolean authoritative, or null if it is not present.
      • requireAuthoritative

        default @NonNull java.lang.Boolean requireAuthoritative()
        Return authoritative, guaranteed to be non-null.
        Returns:
        Boolean authoritative, guaranteed to be non-null.
        Throws:
        java.util.NoSuchElementException - if authoritative is not present