Package org.opendaylight.protocol.util

Class CheckUtil

java.lang.Object
org.opendaylight.protocol.util.CheckUtil
public final class CheckUtil extends Object

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static interface 
    CheckUtil.CheckEquals
     
    static interface 
    CheckUtil.ListenerCheck
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    checkEquals(CheckUtil.CheckEquals function)
     
    static void
    checkEquals(CheckUtil.CheckEquals function, int timeout)
     
    static <T extends org.opendaylight.yangtools.binding.DataObject>
    void
    checkNotPresentConfiguration(org.opendaylight.mdsal.binding.api.DataBroker dataBroker, org.opendaylight.yangtools.binding.DataObjectIdentifier<T> iid)
     
    static <T extends org.opendaylight.yangtools.binding.DataObject>
    void
    checkNotPresentOperational(org.opendaylight.mdsal.binding.api.DataBroker dataBroker, org.opendaylight.yangtools.binding.DataObjectIdentifier<T> iid)
     
    static <T extends org.opendaylight.yangtools.binding.DataObject>
    void
    checkNotPresentOperational(org.opendaylight.mdsal.binding.api.DataBroker dataBroker, org.opendaylight.yangtools.binding.DataObjectIdentifier<T> iid, Duration sustainFor)
    Asserts that iid is absent from the operational datastore and stays absent for sustainFor.
    static <T extends org.opendaylight.yangtools.binding.DataObject>
    T
    checkPresentConfiguration(org.opendaylight.mdsal.binding.api.DataBroker dataBroker, org.opendaylight.yangtools.binding.DataObjectIdentifier<T> iid)
     
    static <T extends org.opendaylight.yangtools.binding.DataObject>
    T
    checkPresentOperational(org.opendaylight.mdsal.binding.api.DataBroker dataBroker, org.opendaylight.yangtools.binding.DataObjectIdentifier<T> iid)
     
    static void
    checkReceivedMessages(CheckUtil.ListenerCheck listener, int numberOfMessages)
     
    static <R, T extends org.opendaylight.yangtools.binding.DataObject>
    R
    readDataConfiguration(org.opendaylight.mdsal.binding.api.DataBroker dataBroker, org.opendaylight.yangtools.binding.DataObjectIdentifier<T> iid, Function<T,R> function)
     
    static <R, T extends org.opendaylight.yangtools.binding.DataObject>
    R
    readDataOperational(org.opendaylight.mdsal.binding.api.DataBroker dataBroker, org.opendaylight.yangtools.binding.DataObjectIdentifier<T> iid, Function<T,R> function)
     
    static <T extends io.netty.util.concurrent.Future<?>>
    void
    waitFutureSuccess(T future)
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • waitFutureSuccess

      public static <T extends io.netty.util.concurrent.Future<?>> void waitFutureSuccess(T future)

    • readDataOperational

      public static <R, T extends org.opendaylight.yangtools.binding.DataObject> R readDataOperational(org.opendaylight.mdsal.binding.api.DataBroker dataBroker, org.opendaylight.yangtools.binding.DataObjectIdentifier<T> iid, Function<T,R> function)

    • readDataConfiguration

      public static <R, T extends org.opendaylight.yangtools.binding.DataObject> R readDataConfiguration(org.opendaylight.mdsal.binding.api.DataBroker dataBroker, org.opendaylight.yangtools.binding.DataObjectIdentifier<T> iid, Function<T,R> function)

    • checkPresentOperational

      public static <T extends org.opendaylight.yangtools.binding.DataObject> T checkPresentOperational(org.opendaylight.mdsal.binding.api.DataBroker dataBroker, org.opendaylight.yangtools.binding.DataObjectIdentifier<T> iid)

    • checkPresentConfiguration

      public static <T extends org.opendaylight.yangtools.binding.DataObject> T checkPresentConfiguration(org.opendaylight.mdsal.binding.api.DataBroker dataBroker, org.opendaylight.yangtools.binding.DataObjectIdentifier<T> iid)

    • checkNotPresentOperational

      public static <T extends org.opendaylight.yangtools.binding.DataObject> void checkNotPresentOperational(org.opendaylight.mdsal.binding.api.DataBroker dataBroker, org.opendaylight.yangtools.binding.DataObjectIdentifier<T> iid)

    • checkNotPresentOperational

      public static <T extends org.opendaylight.yangtools.binding.DataObject> void checkNotPresentOperational(org.opendaylight.mdsal.binding.api.DataBroker dataBroker, org.opendaylight.yangtools.binding.DataObjectIdentifier<T> iid, Duration sustainFor)
      Asserts that iid is absent from the operational datastore and stays absent for sustainFor.

      The plain overload waits up to ten seconds for the data to disappear and returns as soon as it has. This one instead starts asserting immediately and requires absence to hold continuously. Should the data appear within the window, the hold restarts; as the budget is only slightly longer than the window, the check then runs out of time and fails with ConditionTimeoutException, carrying the assertion that last failed as its cause.

      Use this when absence must be verified across an asynchronous writer (e.g. a periodic task) rather than just once.

    • checkNotPresentConfiguration

      public static <T extends org.opendaylight.yangtools.binding.DataObject> void checkNotPresentConfiguration(org.opendaylight.mdsal.binding.api.DataBroker dataBroker, org.opendaylight.yangtools.binding.DataObjectIdentifier<T> iid)

    • checkEquals

      public static void checkEquals(CheckUtil.CheckEquals function)

    • checkEquals

      public static void checkEquals(CheckUtil.CheckEquals function, int timeout)

    • checkReceivedMessages

      public static void checkReceivedMessages(CheckUtil.ListenerCheck listener, int numberOfMessages)