org.springframework.data.redis.core.query.DefaultSortCriterion Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spring-data-redis Show documentation

There is a newer version: 3.2.5

/*
 * Copyright 2011-2018 the original author or authors.
 *
 * 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 org.springframework.data.redis.core.query;

import java.util.ArrayList;
import java.util.List;

import org.springframework.data.redis.connection.SortParameters.Order;
import org.springframework.data.redis.connection.SortParameters.Range;
import org.springframework.lang.Nullable;

/**
 * Default implementation for {@link SortCriterion}.
 *
 * @author Costin Leau
 * @author Christoph Strobl
 */
class DefaultSortCriterion implements SortCriterion {

	private final K key;
	private @Nullable String by;
	private final List getKeys = new ArrayList<>(4);

	private @Nullable Range limit;
	private @Nullable Order order;
	private @Nullable Boolean alpha;

	DefaultSortCriterion(K key) {
		this.key = key;
	}

	public SortCriterion alphabetical(boolean alpha) {
		this.alpha = alpha;
		return this;
	}

	public SortQuery build() {
		return new DefaultSortQuery<>(key, order, alpha, limit, by, getKeys);
	}

	public SortCriterion limit(long offset, long count) {
		this.limit = new Range(offset, count);
		return this;
	}

	// TODO: check if we can use differnt range from SD commons here??

	public SortCriterion limit(Range range) {
		this.limit = range;
		return this;
	}

	public SortCriterion order(Order order) {
		this.order = order;
		return this;
	}

	public SortCriterion get(String getPattern) {
		this.getKeys.add(getPattern);
		return this;
	}

	SortCriterion addBy(String keyPattern) {
		this.by = keyPattern;
		return this;
	}
}