Interface PrefixList

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<PrefixList>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<RouterAdvertisementPacket>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<PrefixListKey>

    @Generated("mdsal-binding-generator")
    public interface PrefixList
    extends org.opendaylight.yangtools.yang.binding.ChildOf<RouterAdvertisementPacket>, org.opendaylight.yangtools.yang.binding.Augmentable<PrefixList>, org.opendaylight.yangtools.yang.binding.Identifiable<PrefixListKey>

    This class represents the following YANG schema fragment defined in module ipv6-neighbor-discovery

     list prefix-list {
       key prefix;
       leaf option-type {
         type uint8;
       }
       leaf option-length {
         type uint8;
       }
       leaf prefix-length {
         type uint8;
       }
       leaf flags {
         type uint8;
       }
       leaf valid-lifetime {
         type uint32;
       }
       leaf preferred-lifetime {
         type uint32;
       }
       leaf reserved {
         type uint32;
       }
       leaf prefix {
         type inet:ipv6-prefix;
       }
     }
     
    The schema path to identify an instance is ipv6-neighbor-discovery/router-advertisement-packet/prefix-list

    To create instances of this class use PrefixListBuilder.

    See Also:
    PrefixListBuilder, PrefixListKey
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME  
    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      static boolean bindingEquals​(@NonNull PrefixList thisObj, java.lang.Object obj)
      Default implementation of Object.equals(Object) contract for this interface.
      static int bindingHashCode​(@NonNull PrefixList obj)
      Default implementation of Object.hashCode() contract for this interface.
      static java.lang.String bindingToString​(@NonNull PrefixList obj)
      Default implementation of Object.toString() contract for this interface.
      org.opendaylight.yangtools.yang.common.Uint8 getFlags()
      Return flags, or null if it is not present.
      org.opendaylight.yangtools.yang.common.Uint8 getOptionLength()
      Return optionLength, or null if it is not present.
      org.opendaylight.yangtools.yang.common.Uint8 getOptionType()
      Return optionType, or null if it is not present.
      org.opendaylight.yangtools.yang.common.Uint32 getPreferredLifetime()
      Return preferredLifetime, or null if it is not present.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix getPrefix()
      Return prefix, or null if it is not present.
      org.opendaylight.yangtools.yang.common.Uint8 getPrefixLength()
      Return prefixLength, or null if it is not present.
      org.opendaylight.yangtools.yang.common.Uint32 getReserved()
      Return reserved, or null if it is not present.
      org.opendaylight.yangtools.yang.common.Uint32 getValidLifetime()
      Return validLifetime, or null if it is not present.
      default java.lang.Class<PrefixList> implementedInterface()  
      PrefixListKey key()  
      • Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

        augmentation, augmentations
    • Field Detail

      • QNAME

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

      • implementedInterface

        default java.lang.Class<PrefixList> 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 PrefixList 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 PrefixList 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 PrefixList 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
      • getOptionType

        org.opendaylight.yangtools.yang.common.Uint8 getOptionType()
        Return optionType, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint8 optionType, or null if it is not present.
      • getOptionLength

        org.opendaylight.yangtools.yang.common.Uint8 getOptionLength()
        Return optionLength, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint8 optionLength, or null if it is not present.
      • getPrefixLength

        org.opendaylight.yangtools.yang.common.Uint8 getPrefixLength()
        Return prefixLength, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint8 prefixLength, or null if it is not present.
      • getFlags

        org.opendaylight.yangtools.yang.common.Uint8 getFlags()
        Return flags, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint8 flags, or null if it is not present.
      • getValidLifetime

        org.opendaylight.yangtools.yang.common.Uint32 getValidLifetime()
        Return validLifetime, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 validLifetime, or null if it is not present.
      • getPreferredLifetime

        org.opendaylight.yangtools.yang.common.Uint32 getPreferredLifetime()
        Return preferredLifetime, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 preferredLifetime, or null if it is not present.
      • getReserved

        org.opendaylight.yangtools.yang.common.Uint32 getReserved()
        Return reserved, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 reserved, or null if it is not present.
      • getPrefix

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix getPrefix()
        Return prefix, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix prefix, or null if it is not present.