com.querydsl.core.BooleanBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of querydsl-core Show documentation
core module for querydsl
There is a newer version: 6.8
/*
 * Copyright 2015, The Querydsl Team (http://www.querydsl.com/team)
 *
 * Licensed 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 com.querydsl.core;

import com.querydsl.core.types.Expression;
import com.querydsl.core.types.ExpressionUtils;
import com.querydsl.core.types.Predicate;
import com.querydsl.core.types.Visitor;
import java.util.Objects;
import org.jetbrains.annotations.Nullable;

/**
 * {@code BooleanBuilder} is a cascading builder for {@link Predicate} expressions. {@code
 * BooleanBuilder} is a mutable {@link Expression} implementation.
 *
 * Usage example:
 *
 * 
 * QEmployee employee = QEmployee.employee;
 * BooleanBuilder builder = new BooleanBuilder();
 * for (String name : names) {
 *     builder.or(employee.name.equalsIgnoreCase(name));
 * }
 * 
 *
 * @author tiwe
 */
public final class BooleanBuilder implements Predicate, Cloneable {

  private static final long serialVersionUID = -4129485177345542519L;

  @Nullable private Predicate predicate;

  /** Create an empty BooleanBuilder */
  public BooleanBuilder() {}

  /**
   * Create a BooleanBuilder with the given initial value
   *
   * @param initial initial value
   */
  public BooleanBuilder(Predicate initial) {
    predicate = (Predicate) ExpressionUtils.extract(initial);
  }

  @Override
  public  R accept(Visitor v, C context) {
    if (predicate != null) {
      return predicate.accept(v, context);
    } else {
      return null;
    }
  }

  /**
   * Create the intersection of this and the given predicate
   *
   * @param right right hand side of {@code and} operation
   * @return the current object
   */
  public BooleanBuilder and(@Nullable Predicate right) {
    if (right != null) {
      if (predicate == null) {
        predicate = right;
      } else {
        predicate = ExpressionUtils.and(predicate, right);
      }
    }
    return this;
  }

  /**
   * Create the intersection of this and the union of the given args {@code (this && (arg1 || arg2
   * ... || argN))}
   *
   * @param args union of predicates
   * @return the current object
   */
  public BooleanBuilder andAnyOf(Predicate... args) {
    if (args.length > 0) {
      and(ExpressionUtils.anyOf(args));
    }
    return this;
  }

  /**
   * Create the insertion of this and the negation of the given predicate
   *
   * @param right predicate to be negated
   * @return the current object
   */
  public BooleanBuilder andNot(Predicate right) {
    return and(right.not());
  }

  @Override
  public BooleanBuilder clone() throws CloneNotSupportedException {
    return (BooleanBuilder) super.clone();
  }

  @Override
  public boolean equals(Object o) {
    if (o == this) {
      return true;
    } else if (o instanceof BooleanBuilder) {
      return Objects.equals(((BooleanBuilder) o).getValue(), predicate);
    } else {
      return false;
    }
  }

  @Nullable
  public Predicate getValue() {
    return predicate;
  }

  @Override
  public int hashCode() {
    return predicate != null ? predicate.hashCode() : 0;
  }

  /**
   * Returns true if the value is set, and false, if not
   *
   * @return true if initialized and false if not
   */
  public boolean hasValue() {
    return predicate != null;
  }

  @Override
  public BooleanBuilder not() {
    if (predicate != null) {
      predicate = predicate.not();
    }
    return this;
  }

  /**
   * Create the union of this and the given predicate
   *
   * @param right right hand side of {@code or} operation
   * @return the current object
   */
  public BooleanBuilder or(@Nullable Predicate right) {
    if (right != null) {
      if (predicate == null) {
        predicate = right;
      } else {
        predicate = ExpressionUtils.or(predicate, right);
      }
    }
    return this;
  }

  /**
   * Create the union of this and the intersection of the given args {@code (this || (arg1 && arg2
   * ... && argN))}
   *
   * @param args intersection of predicates
   * @return the current object
   */
  public BooleanBuilder orAllOf(Predicate... args) {
    if (args.length > 0) {
      or(ExpressionUtils.allOf(args));
    }
    return this;
  }

  /**
   * Create the union of this and the negation of the given predicate
   *
   * @param right predicate to be negated
   * @return the current object
   */
  public BooleanBuilder orNot(Predicate right) {
    return or(right.not());
  }

  @Override
  public Class getType() {
    return Boolean.class;
  }

  @Override
  public String toString() {
    return predicate != null ? predicate.toString() : super.toString();
  }
}