Interface Prefix
-
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<Prefix>
,org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.ChildOf<Prefixes>
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
,org.opendaylight.yangtools.yang.binding.Identifiable<PrefixKey>
@Generated("mdsal-binding-generator") public interface Prefix extends org.opendaylight.yangtools.yang.binding.ChildOf<Prefixes>, org.opendaylight.yangtools.yang.binding.Augmentable<Prefix>, org.opendaylight.yangtools.yang.binding.Identifiable<PrefixKey>
A prefix is a rule with a BGP filter. The left hand side of the rule is the prefix filter. It specifies a set of IP addresses. If a BGP announcement contains an address that matches, the rule is applied. The right hand side of the rule specifies the action that is to be applied.This class represents the following YANG schema fragment defined in module bgp
list prefix { key seq-nr; leaf seq-nr { type uint16; } container prefix-filter { choice ip-address-group { case ip-address { leaf ip-address { type inet:ip-address; } } case prefix { leaf prefix { type inet:ip-prefix; } } case host { leaf ip-host-address { type inet:host; } } case ip-range { leaf lower { type inet:ip-address; } leaf upper { type inet:ip-address; } } } leaf action { type actions-enum; } container statistics { leaf prefix-hit-count { type uint32; config false; } } } }
The schema path to identify an instance is bgp/prefix-lists/prefix-list/prefixes/prefixTo create instances of this class use
PrefixBuilder
.- See Also:
PrefixBuilder
,PrefixKey
-
-
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 Prefix thisObj, java.lang.Object obj)
Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode(@NonNull Prefix obj)
Default implementation ofObject.hashCode()
contract for this interface.static java.lang.String
bindingToString(@NonNull Prefix obj)
Default implementation ofObject.toString()
contract for this interface.PrefixFilter
getPrefixFilter()
Return prefixFilter, ornull
if it is not present.org.opendaylight.yangtools.yang.common.Uint16
getSeqNr()
Return seqNr, ornull
if it is not present.default java.lang.Class<Prefix>
implementedInterface()
PrefixKey
key()
-
-
-
Method Detail
-
implementedInterface
default java.lang.Class<Prefix> implementedInterface()
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataContainer
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataObject
-
bindingHashCode
static int bindingHashCode(@NonNull Prefix obj)
Default implementation ofObject.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
- ifobj
is null
-
bindingEquals
static boolean bindingEquals(@NonNull Prefix thisObj, java.lang.Object obj)
Default implementation ofObject.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 invocationobj
- Object acting as argument to equals invocation- Returns:
- True if thisObj and obj are considered equal
- Throws:
java.lang.NullPointerException
- ifthisObj
is null
-
bindingToString
static java.lang.String bindingToString(@NonNull Prefix obj)
Default implementation ofObject.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
- ifobj
is null
-
getSeqNr
org.opendaylight.yangtools.yang.common.Uint16 getSeqNr()
Return seqNr, ornull
if it is not present.Sequence number of the rule. The sequence number is included for compatibility purposes with CLI; from a machine-to-machine interface perspective, it would strictly speaking not be required as list elements can be arranged in a particular order.
- Returns:
org.opendaylight.yangtools.yang.common.Uint16
seqNr, ornull
if it is not present.
-
getPrefixFilter
PrefixFilter getPrefixFilter()
Return prefixFilter, ornull
if it is not present.- Returns:
org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.prefix.lists.prefix.list.prefixes.prefix.PrefixFilter
prefixFilter, ornull
if it is not present.
-
-