org.eclipse.jnosql.communication.query.DeleteQuery Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jnosql-communication-query Show documentation
There is a newer version: 1.1.3
Show newest version
/*
 *  Copyright (c) 2023 Contributors to the Eclipse Foundation
 *  All rights reserved. This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License v1.0
 *  and Apache License v2.0 which accompanies this distribution.
 *  The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 *  and the Apache License v2.0 is available at http://www.opensource.org/licenses/apache2.0.php.
 *  You may elect to redistribute this code under either of these licenses.
 *  Contributors:
 *  Otavio Santana
 */
package org.eclipse.jnosql.communication.query;

import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;


/**
 * Deleting either an entity or fields uses the DELETE statement
 */
public class DeleteQuery implements Query {

    private final String entity;

    private final List fields;

    private final Where where;

    private DeleteQuery(String entity, List fields, Where where) {
        this.entity = entity;
        this.fields = fields;
        this.where = where;
    }

    /**
     * The fields that will delete in this query, if this fields is empty, this query will remove the whole entity.
     *
     * @return the fields list
     */
    public List fields() {
        return Collections.unmodifiableList(fields);
    }

    /**
     * The entity name
     *
     * @return the entity name
     */
    public String entity() {
        return entity;
    }

    /**
     * The condition at this {@link DeleteQuery}, if the Where is empty that means will delete the whole entities.
     *
     * @return the {@link Where} entity otherwise {@link Optional#empty()}
     */
    public Optional where() {
        return Optional.ofNullable(where);
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (!(o instanceof DeleteQuery that)) {
            return false;
        }
        return Objects.equals(entity, that.entity) &&
                Objects.equals(fields, that.fields) &&
                Objects.equals(where, that.where);
    }

    @Override
    public int hashCode() {
        return Objects.hash(entity, fields, where);
    }

    @Override
    public String toString() {
        return "DeleteQuery{" +
                "entity='" + entity + '\'' +
                ", fields=" + fields +
                ", where=" + where +
                '}';
    }

    /**
     * Create {@link DeleteQuery}
     *
     * @param entity the entity
     * @param fields the fields
     * @param where  the where
     * @return a {@link DeleteQuery} instance
     * @throws NullPointerException when parameter is null
     */
    public static DeleteQuery of(String entity, List fields, Where where) {
        Objects.requireNonNull(entity, "entity is required");
        Objects.requireNonNull(fields, "fields is required");
        return new DeleteQuery(entity, fields, where);
    }

    /**
     * Create {@link DeleteQuery} with fields as {@link Collections#emptyList()}
     *
     * @param entity the entity
     * @param where  the where
     * @return a {@link DeleteQuery} instance
     * @throws NullPointerException when parameter is null
     */
    public static DeleteQuery of(String entity, Where where) {
        Objects.requireNonNull(entity, "entity is required");
        return new DeleteQuery(entity, Collections.emptyList(), where);
    }
}