Interface OriginatorIdSet

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<OriginatorIdSet>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<OriginatorIdSet>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<OriginatorIdSetKey>

    @Generated("mdsal-binding-generator")
    public interface OriginatorIdSet
    extends org.opendaylight.yangtools.yang.binding.ChildOf<OriginatorIdSet>, org.opendaylight.yangtools.yang.binding.Augmentable<OriginatorIdSet>, org.opendaylight.yangtools.yang.binding.Identifiable<OriginatorIdSetKey>
    List of the defined Originators Ids sets

    This class represents the following YANG schema fragment defined in module odl-bgp-policy

     list originator-id-set {
       key originator-id-set-name;
       leaf originator-id-set-name {
         type string;
       }
       leaf-list originator-id {
         type inet:ipv4-address-no-zone;
       }
       container local {
         presence "Local originator Id";
       }
     }
     
    The schema path to identify an instance is odl-bgp-policyoriginator-id-setoriginator-id-set

    To create instances of this class use OriginatorIdSetBuilder.

    See Also:
    OriginatorIdSetBuilder, OriginatorIdSetKey
    • Field Detail

      • QNAME

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

      • implementedInterface

        default Class<OriginatorIdSet> 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 OriginatorIdSet 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 OriginatorIdSet 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 OriginatorIdSet 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
      • getOriginatorIdSetName

        String getOriginatorIdSetName()
        Return originatorIdSetName, or null if it is not present.
             
                 name / label of the set -- this is used to reference the set in match conditions
             
         
        Returns:
        String originatorIdSetName, or null if it is not present.
      • requireOriginatorIdSetName

        default @NonNull String requireOriginatorIdSetName()
        Return originatorIdSetName, guaranteed to be non-null.
             
                 name / label of the set -- this is used to reference the set in match conditions
             
         
        Returns:
        String originatorIdSetName, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if originatorIdSetName is not present
      • getOriginatorId

        @Nullable List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone> getOriginatorId()
        Return originatorId, or null if it is not present.
             
                 List of role expressions that are part of the set
             
         
        Returns:
        List<Ipv4AddressNoZone> originatorId, or null if it is not present.
      • requireOriginatorId

        default @NonNull List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone> requireOriginatorId()
        Return originatorId, guaranteed to be non-null.
             
                 List of role expressions that are part of the set
             
         
        Returns:
        List<Ipv4AddressNoZone> originatorId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if originatorId is not present
      • getLocal

        Local getLocal()
        Return local, or null if it is not present.
             
                 Validates also Local Originator Id
             
         
        Returns:
        Local local, or null if it is not present.