org.eclipse.jnosql.communication.query.GetQuery 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.4

Show newest version

/*
 *  Copyright (c) 2022 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.List;
import java.util.Objects;

import static java.util.Collections.unmodifiableList;


/**
 * To retrieve one or more entities use the GET statement.
 * This query is particular to a key-value database.
 */
public final class GetQuery implements Query {

    private final List> keys;

    GetQuery(List> keys) {
        this.keys = keys;
    }

    /**
     * The keys to being retrieved from the query
     *
     * @return the keys
     */
    public List> keys() {
        return unmodifiableList(keys);
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (!(o instanceof GetQuery that)) {
            return false;
        }
        return Objects.equals(keys, that.keys);
    }

    @Override
    public int hashCode() {
        return Objects.hashCode(keys);
    }

    @Override
    public String toString() {
        return this.keys.toString();
    }

    /**
     * Obtains an instance of {@link GetQuery} from a text string.
     *
     * @param query the query
     * @return {@link GetQuery} instance
     * @throws NullPointerException                    when the query is null
     */
    public static GetQuery parse(String query) {
        Objects.requireNonNull(query, "query is required");
        return new GetQueryConverter().apply(query);
    }
}