Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.prefix.set

Interface PrefixSet

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<PrefixSet>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<PrefixSet>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<PrefixSetKey>
    @Generated("mdsal-binding-generator")
public interface PrefixSet
extends org.opendaylight.yangtools.yang.binding.ChildOf<PrefixSet>, org.opendaylight.yangtools.yang.binding.Augmentable<PrefixSet>, org.opendaylight.yangtools.yang.binding.Identifiable<PrefixSetKey>
    List of the defined prefix sets

    This class represents the following YANG schema fragment defined in module openconfig-routing-policy 

     list prefix-set {
   key prefix-set-name;
   leaf prefix-set-name {
     type string;
   }
   list prefix {
     key "ip-prefix masklength-range";
     leaf ip-prefix {
       type inet:ip-prefix;
     }
     leaf masklength-range {
       type string {
         pattern ([0-9]+\.\.[0-9]+)|exact;
       }
     }
   }
 }
    The schema path to identify an instance is openconfig-routing-policyprefix-setprefix-set

    To create instances of this class use PrefixSetBuilder.

    See Also:
    PrefixSetBuilder, PrefixSetKey

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        default Class<PrefixSet> 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 PrefixSet 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 PrefixSet 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 PrefixSet 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

        PrefixSetKey key()
        Specified by:
        key in interface org.opendaylight.yangtools.yang.binding.Identifiable<PrefixSetKey>

      • getPrefixSetName

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

      • requirePrefixSetName

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

      • getPrefix

        @Nullable Map<PrefixKey,​Prefix> getPrefix()
        Return prefix, or null if it is not present. 
             
         List of prefix expressions that are part of the set
        Returns:
        Map<PrefixKey, Prefix> prefix, or null if it is not present.

      • nonnullPrefix

        default @NonNull Map<PrefixKey,​Prefix> nonnullPrefix()
        Return prefix, or an empty list if it is not present.
        Returns:
        Map<PrefixKey, Prefix> prefix, or an empty list if it is not present.