Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.submit.instruction.output.result.failure._case

Interface Failure

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Failure>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<SubmitInstructionOutput>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    @Generated("mdsal-binding-generator")
public interface Failure
extends org.opendaylight.yangtools.yang.binding.ChildOf<SubmitInstructionOutput>, org.opendaylight.yangtools.yang.binding.Augmentable<Failure>

    This class represents the following YANG schema fragment defined in module programming 

     container failure {
   leaf type {
     type identityref {
       base submit-failure;
     }
   }
   leaf-list failed-preconditions {
     when "../type = dead-on-arrival";
     type instruction-id;
   }
 }
    The schema path to identify an instance is programmingsubmit-instruction-outputresultfailure-casefailure

    To create instances of this class use FailureBuilder.

    See Also:
    FailureBuilder

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

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

      • getType

        Class<? extends SubmitFailure> getType()
        Return type, or null if it is not present.
        Returns:
        Class<? extends SubmitFailure> type, or null if it is not present.

      • requireType

        default @NonNull Class<? extends SubmitFailure> requireType()
        Return type, guaranteed to be non-null.
        Returns:
        Class<? extends SubmitFailure> type, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if type is not present

      • getFailedPreconditions

        @Nullable List<InstructionId> getFailedPreconditions()
        Return failedPreconditions, or null if it is not present.
        Returns:
        List<InstructionId> failedPreconditions, or null if it is not present.

      • requireFailedPreconditions

        default @NonNull List<InstructionId> requireFailedPreconditions()
        Return failedPreconditions, guaranteed to be non-null.
        Returns:
        List<InstructionId> failedPreconditions, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if failedPreconditions is not present