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

Interface Prefix

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<Prefix>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, 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.KeyAware<PrefixKey>
@Generated("mdsal-binding-generator") public interface Prefix extends org.opendaylight.yangtools.yang.binding.ChildOf<PrefixSet>, org.opendaylight.yangtools.yang.binding.Augmentable<Prefix>, org.opendaylight.yangtools.yang.binding.KeyAware<PrefixKey>
List of prefix expressions that are part of the set

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

 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;
     }
   }
 }

To create instances of this class use PrefixBuilder.

See Also:

  • 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 Prefix thisObj, Object obj)
    Default implementation of Object.equals(Object) contract for this interface.
    static int
    bindingHashCode(@NonNull Prefix obj)
    Default implementation of Object.hashCode() contract for this interface.
    static String
    bindingToString(@NonNull Prefix obj)
    Default implementation of Object.toString() contract for this interface.
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix
    getIpPrefix()
    Return ipPrefix, or null if it is not present.
    String
    getMasklengthRange()
    Return masklengthRange, or null if it is not present.
    default Class<Prefix>
    implementedInterface()
     
    PrefixKey
    key()
     
    default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix
    requireIpPrefix()
    Return ipPrefix, guaranteed to be non-null.
    default @NonNull String
    requireMasklengthRange()
    Return masklengthRange, 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<Prefix> 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 Prefix 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 Prefix 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 Prefix 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

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

    • getIpPrefix

      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getIpPrefix()
      Return ipPrefix, or null if it is not present. 
           
         The prefix member in CIDR notation -- while the prefix may be either IPv4 or
         IPv6, most implementations require all members of the prefix set to be the same
         address family. Mixing address types in the same prefix set is likely to cause
         an error.
      Returns:
      IpPrefix ipPrefix, or null if it is not present.

    • requireIpPrefix

      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix requireIpPrefix()
      Return ipPrefix, guaranteed to be non-null. 
           
         The prefix member in CIDR notation -- while the prefix may be either IPv4 or
         IPv6, most implementations require all members of the prefix set to be the same
         address family. Mixing address types in the same prefix set is likely to cause
         an error.
      Returns:
      IpPrefix ipPrefix, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if ipPrefix is not present

    • getMasklengthRange

      String getMasklengthRange()
      Return masklengthRange, or null if it is not present. 
           
         Defines a range for the masklength, or 'exact' if the prefix has an exact
         length. Example: 10.3.192.0/21 through 10.3.192.0/24 would be expressed as
         prefix: 10.3.192.0/21, masklength-range: 21..24. Example: 10.3.192.0/21 would be
         expressed as prefix: 10.3.192.0/21, masklength-range: exact
      Returns:
      String masklengthRange, or null if it is not present.

    • requireMasklengthRange

      default @NonNull String requireMasklengthRange()
      Return masklengthRange, guaranteed to be non-null. 
           
         Defines a range for the masklength, or 'exact' if the prefix has an exact
         length. Example: 10.3.192.0/21 through 10.3.192.0/24 would be expressed as
         prefix: 10.3.192.0/21, masklength-range: 21..24. Example: 10.3.192.0/21 would be
         expressed as prefix: 10.3.192.0/21, masklength-range: exact
      Returns:
      String masklengthRange, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if masklengthRange is not present