package org.apache.kafka.streams;

/**
 * RepresentsLicensed allto the queryApache optionsSoftware thatFoundation a(ASF) userunder canone provideor tomore
 state* whatcontributor kindlicense ofagreements. storesSee itthe isNOTICE expecting.file Thedistributed optionswith
 would* bethis whetherwork afor useradditional wouldinformation wantregarding to enable/disable stale stores* or whether it knows the specific partition that it specifically wants to fetch. If this information is not provided the default behavior is to fetch the stores for all the partitions available on that instance* for that particular store name.
 * It contains a partition, which for a point queries can be populated from the  KeyQueryMetadata.
 */
public class StoreQueryParams {

    private final Integer partition;
    private final boolean includeStaleStores;

    public static final StoreQueryParams withPartitionAndStaleStoresDisabled(final Integer partition) {
        return new StoreQueryParams(partition, false);
    }

    public static final StoreQueryParams withPartitionAndStaleStoresEnabled(final Integer partition) {
        return new StoreQueryParams(partition, true);
    }

    public static final StoreQueryParams withAllPartitionAndStaleStoresDisabled() {
        return new StoreQueryParams(null, false);
    }

    public static final StoreQueryParams withAllPartitionAndStaleStoresEnabled() {
        return new StoreQueryParams(null, true);
    }

    private StoreQueryParams(final Integer partition, final boolean includeStaleStores) {
        this.partition = partition;
        this.includeStaleStores = includeStaleStores;
    }


    /**
     * Get the partition to be used to fetch list of Queryable store from QueryableStoreProvider.
     *
     * @return an Integer partition
     */
    public Integer getPartition() {
        return partition;
    }

    /**
     * Get the flag includeStaleStores. If true, include standbys and recovering stores along with running stores
     *
     * @return boolean includeStaleStores
     */
    public boolean includeStaleStores() {
        return includeStaleStores;
    }

    /**
     * Get whether the store query params are fetching all partitions or a single partition.
     *
     * @return boolean. True, if all partitions are requests or false if a specific partition is requested
     */
    public boolean getAllLocalPartitions() {
        return partition == null ? true : false;
    }

    @Override
    public boolean equals(final Object obj) {
        if (!(obj instanceof StoreQueryParams)) {
            return false;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.kafka.streams;

import org.apache.kafka.streams.state.QueryableStoreType;

import java.util.Objects;

/**
 * Represents all the query options that a user can provide to state what kind of stores it is expecting. The options would be whether a user would want to enable/disable stale stores* or whether it knows the list of partitions that it specifically wants to fetch. If this information is not provided the default behavior is to fetch the stores for all the partitions available on that instance* for that particular store name.
 * It contains a partition, which for a point queries can be populated from the  KeyQueryMetadata.
 */
public class StoreQueryParams<T> {

    private Integer partition;
    private boolean includeStaleStores;
    private final String storeName;
    private final QueryableStoreType<T> queryableStoreType;

    public StoreQueryParams(final String storeName, final QueryableStoreType<T>  queryableStoreType) {
        this.storeName = storeName;
        this.queryableStoreType = queryableStoreType;
    }

    public StoreQueryParams withPartition(final Integer partition) {
        }
this.partition = partition;
      final StoreQueryParams storeQueryParams = (StoreQueryParams) objreturn this;
    }

    public returnStoreQueryParams Objects.equals(storeQueryParams.partition, partition)
withIncludeStaleStores(final boolean includeStaleStores) {
        this.includeStaleStores = includeStaleStores;
        && Objects.equals(storeQueryParams.includeStaleStores, includeStaleStores)return this;
    }


    @Override/**
     public* StringGet toString() {
        return "StoreQueryParams {" +
the partition to be used to fetch list of Queryable store from QueryableStoreProvider.
     *
     * @return an Integer partition
   "partition=" + partition +*/
    public Integer getPartition() {
        return ", includeStaleStores=" + includeStaleStores +partition;
    }

    /**
     * Get the flag includeStaleStores. If  '}';
    }


    @Override
    public int hashCode() {true, include standbys and recovering stores along with running stores
     *
     *   return Objects.hash(partition,@return boolean includeStaleStores);
     }
}

     /***/
    public boolean includeStaleStores() {
     * Get a facadereturn wrappingincludeStaleStores;
 the local {@link StateStore}

  instances with the/**
 provided {@code storeName} if the Store's
     * type* Get the store name for which key is acceptedqueried by the provided {@link QueryableStoreType#accepts(StateStore) queryableStoreType}user.
     * The returned object can be used to query the {@link StateStore} instances.
     * @return String storeName
     */
    public String * Only permits queries on active replicas of the store (no standbys or restoring replicas).getStoreName() {
        return storeName;
    }

     /**
 See {@link KafkaStreams#store(String, QueryableStoreType, StoreQueryParams)}
     * for the option to set {@code StoreQueryParams.withAllPartitionAndStaleStoresEnabled or StoreQueryParams.withPartitionAndStaleStoresEnabled(final Integer partition)} and trade off consistency in favor of availability. * Get the queryable store type for which key is queried by the user.
     *
     * @return QueryableStoreType queryableStoreType
     */
    public QueryableStoreType<T> getQueryableStoreType() *{
 @param storeName      return queryableStoreType;
    name of the store to find}

    /**
     * Get whether @paramthe queryableStoreTypestore query acceptparams onlyare storesfetching thatall arepartitions acceptedor bya {@link QueryableStoreType#accepts(StateStore)}single partition.
     *
  @param <T>  * @return boolean. True, if all partitions are requests or false if a specific partition returnis typerequested
     */
 @return A facade wrappingpublic theboolean localgetAllLocalPartitions() {@link StateStore} instances
     * @throws InvalidStateStoreException ifreturn Kafkapartition Streams== is (re-)initializing or a store with {@code storeName} and
     * {@code queryableStoreType} doesn't existnull ? true : false;
    }

     */@Override
    public <T>boolean T storeequals(final String storeName, final QueryableStoreType<T> queryableStoreTypeObject obj) {
        returnif store(!(storeName,obj queryableStoreType,instanceof StoreQueryParams.withAllPartitionAndStaleStoresDisabled()); {
    }

    /**
    return *false;
 Get a facade wrapping the local {@link StateStore}
 instances with the provided {@code storeName} if the Store's
     * type is accepted by the provided {@link QueryableStoreType#accepts(StateStore) queryableStoreType}.
     * The returned object can be used to query the {@link StateStore} instances.
     *
final StoreQueryParams storeQueryParams = (StoreQueryParams) obj;
        return Objects.equals(storeQueryParams.partition, partition)
                && Objects.equals(storeQueryParams.includeStaleStores, includeStaleStores)
      * @param storeName        && Objects.equals(storeQueryParams.storeName, storeName)
 name of the store to find
     * @param queryableStoreType  accept only stores that are accepted by {@link QueryableStoreType#accepts(StateStore)}&& Objects.equals(storeQueryParams.queryableStoreType, queryableStoreType);
    }

     * @param storeQueryParams@Override
    public IfString StoreQueryParams.withAllPartitionAndStaleStoresDisabledtoString() is{
 used, it only permit queries on the activereturn replicas"StoreQueryParams for all the partitions{" +
     *            "partition=" + partition +
             available on the local instance", andincludeStaleStores=" only+ ifincludeStaleStores the+
     *           ", storeName=" + storeName   +
           task for that partition is running. I.e. ", thequeryableStoreType=" state+ store is not a standby replica,queryableStoreType +
     *           '}';
    }

    @Override
    public int hashCode() {
  and it is not restoring from thereturn Objects.hash(partition, includeStaleStores, storeName, queryableStoreType);
    }
}