org.apache.flink.cep.pattern.conditions.OrCondition Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of flink-cep Show documentation

There is a newer version: 2.0-preview1

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.cep.pattern.conditions;

import org.apache.flink.annotation.Internal;
import org.apache.flink.util.Preconditions;

/**
 * A {@link IterativeCondition condition} which combines two conditions with a logical {@code OR}
 * and returns {@code true} if at least one is {@code true}.
 *
 * @param  Type of the element to filter
 * @deprecated Please use {@link RichOrCondition} instead. This class exists just for backwards
 *     compatibility and will be removed in FLINK-10113.
 */
@Internal
@Deprecated
public class OrCondition extends IterativeCondition {

    private static final long serialVersionUID = 2554610954278485106L;

    private final IterativeCondition left;
    private final IterativeCondition right;

    public OrCondition(final IterativeCondition left, final IterativeCondition right) {
        this.left = Preconditions.checkNotNull(left, "The condition cannot be null.");
        this.right = Preconditions.checkNotNull(right, "The condition cannot be null.");
    }

    @Override
    public boolean filter(T value, Context ctx) throws Exception {
        return left.filter(value, ctx) || right.filter(value, ctx);
    }

    /** @return One of the {@link IterativeCondition conditions} combined in this condition. */
    public IterativeCondition getLeft() {
        return left;
    }

    /** @return One of the {@link IterativeCondition conditions} combined in this condition. */
    public IterativeCondition getRight() {
        return right;
    }
}