org.springframework.data.redis.core.KeyScanOptions 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 2014-2022 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
 *
 *      https://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;

import java.util.StringJoiner;

import org.springframework.data.redis.connection.DataType;
import org.springframework.lang.Nullable;
import org.springframework.util.StringUtils;

/**
 * Options to be used for with {@literal SCAN} commands.
 *
 * @author Mark Paluch
 * @author Christoph Strobl
 * @since 2.6
 */
public class KeyScanOptions extends ScanOptions {

	/**
	 * Constant to apply default {@link KeyScanOptions} without setting a limit or matching a pattern.
	 */
	public static KeyScanOptions NONE = new KeyScanOptions(null, null, null, null);

	private final @Nullable String type;

	KeyScanOptions(@Nullable Long count, @Nullable String pattern, @Nullable byte[] bytePattern,
			@Nullable String type) {

		super(count, pattern, bytePattern);
		this.type = type;
	}

	/**
	 * Static factory method that returns a new {@link ScanOptionsBuilder}.
	 *
	 * @param type 
	 * @return
	 */
	public static ScanOptionsBuilder scanOptions(DataType type) {
		return new ScanOptionsBuilder().type(type);
	}

	@Nullable
	public String getType() {
		return type;
	}

	@Override
	public String toOptionString() {

		if (this.equals(KeyScanOptions.NONE)) {
			return "";
		}

		StringJoiner joiner = new StringJoiner(", ").add(super.toOptionString());

		if (StringUtils.hasText(type)) {
			joiner.add("'type' '" + type + "'");
		}

		return joiner.toString();
	}
}