io.deephaven.api.updateby.NullBehavior Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of deephaven-table-api Show documentation

The Deephaven table operations API

The newest version!

//
// Copyright (c) 2016-2024 Deephaven Data Labs and Patent Pending
//
package io.deephaven.api.updateby;

/**
 * The action that should be taken when the previous value is {@code null}
 */
public enum NullBehavior {
    /**
     * In the case of Current - null, the null dominates so Column[i] - null = null
     */
    NullDominates,

    /**
     * In the case of Current - null, the current value dominates so Column[i] - null = Column[i]
     */
    ValueDominates,

    /**
     * In the case of Current - null, return zero so Column[i] - null = 0
     */
    ZeroDominates
}