Interface Statement

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Statement>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Statements>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<StatementKey>

    @Generated("mdsal-binding-generator")
    public interface Statement
    extends org.opendaylight.yangtools.yang.binding.ChildOf<Statements>, org.opendaylight.yangtools.yang.binding.Augmentable<Statement>, org.opendaylight.yangtools.yang.binding.Identifiable<StatementKey>
    Policy statements group conditions and actions within a policy definition. They are evaluated in the order specified (see the description of policy evaluation at the top of this module.

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

     list statement {
       key name;
       ordered-by user;
       leaf name {
         type string;
       }
       container conditions {
         leaf call-policy {
           type leafref {
             path /rpol:routing-policy/rpol:policy-definitions/rpol:policy-definition/rpol:name;
           }
         }
         uses generic-conditions;
         uses igp-conditions;
       }
       container actions {
         uses generic-actions;
         uses igp-actions;
       }
     }
     

    To create instances of this class use StatementBuilder.

    See Also:
    StatementBuilder, StatementKey
    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
        YANG identifier of the statement represented by this class.
    • Method Detail

      • implementedInterface

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

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

        String getName()
        Return name, or null if it is not present.
             
                 name of the policy statement
             
         
        Returns:
        String name, or null if it is not present.
      • requireName

        default @NonNull String requireName()
        Return name, guaranteed to be non-null.
             
                 name of the policy statement
             
         
        Returns:
        String name, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if name is not present
      • getConditions

        Conditions getConditions()
        Return conditions, or null if it is not present.
             
                 Condition statements for this policy statement
             
         
        Returns:
        Conditions conditions, or null if it is not present.
      • getActions

        Actions getActions()
        Return actions, or null if it is not present.
             
                 Action statements for this policy statement
             
         
        Returns:
        Actions actions, or null if it is not present.