cn.hutool.core.lang.Range Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hutool-all Show documentation
Hutool是一个小而全的Java工具类库，通过静态方法封装，降低相关API的学习成本，提高工作效率，使Java拥有函数式语言般的优雅，让Java语言也可以“甜甜的”。
There is a newer version: 5.8.34
package cn.hutool.core.lang;

import cn.hutool.core.thread.lock.NoLock;

import java.io.Serializable;
import java.util.Iterator;
import java.util.NoSuchElementException;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantLock;
import java.util.concurrent.locks.ReentrantReadWriteLock;

/**
 * 范围生成器。根据给定的初始值、结束值和步进生成一个步进列表生成器

 * 由于用户自行实现{@link Stepper}来定义步进，因此Range本身无法判定边界（是否达到end），需在step实现边界判定逻辑。
 *
 * 
 * 此类使用{@link ReentrantReadWriteLock}保证线程安全
 * 
 *
 * @param  生成范围对象的类型
 * @author Looly
 */
public class Range implements Iterable, Iterator, Serializable {
	private static final long serialVersionUID = 1L;

	/**
	 * 锁保证线程安全
	 */
	private Lock lock = new ReentrantLock();
	/**
	 * 起始对象
	 */
	private final T start;
	/**
	 * 结束对象
	 */
	private final T end;
	/**
	 * 下一个对象
	 */
	private T next;
	/**
	 * 步进
	 */
	private final Stepper stepper;
	/**
	 * 索引
	 */
	private int index = 0;
	/**
	 * 是否包含第一个元素
	 */
	private final boolean includeStart;
	/**
	 * 是否包含最后一个元素
	 */
	private final boolean includeEnd;

	/**
	 * 构造
	 *
	 * @param start   起始对象（包括）
	 * @param stepper 步进
	 */
	public Range(T start, Stepper stepper) {
		this(start, null, stepper);
	}

	/**
	 * 构造
	 *
	 * @param start   起始对象（包含）
	 * @param end     结束对象（包含）
	 * @param stepper 步进
	 */
	public Range(T start, T end, Stepper stepper) {
		this(start, end, stepper, true, true);
	}

	/**
	 * 构造
	 *
	 * @param start          起始对象
	 * @param end            结束对象
	 * @param stepper        步进
	 * @param isIncludeStart 是否包含第一个元素
	 * @param isIncludeEnd   是否包含最后一个元素
	 */
	public Range(T start, T end, Stepper stepper, boolean isIncludeStart, boolean isIncludeEnd) {
		Assert.notNull(start, "First element must be not null!");
		this.start = start;
		this.end = end;
		this.stepper = stepper;
		this.next = safeStep(this.start);
		this.includeStart = isIncludeStart;
		this.includeEnd = isIncludeEnd;
	}

	/**
	 * 禁用锁，调用此方法后不再使用锁保护
	 *
	 * @return this
	 * @since 4.3.1
	 */
	public Range disableLock() {
		this.lock = new NoLock();
		return this;
	}

	@Override
	public boolean hasNext() {
		lock.lock();
		try {
			if (0 == this.index && this.includeStart) {
				return true;
			}
			if (null == this.next) {
				return false;
			} else if (false == includeEnd && this.next.equals(this.end)) {
				return false;
			}
		} finally {
			lock.unlock();
		}
		return true;
	}

	@Override
	public T next() {
		lock.lock();
		try {
			if (false == this.hasNext()) {
				throw new NoSuchElementException("Has no next range!");
			}
			return nextUncheck();
		} finally {
			lock.unlock();
		}
	}

	/**
	 * 获取下一个元素，并将下下个元素准备好
	 */
	private T nextUncheck() {
		T current;
		if(0 == this.index){
			current = start;
			if(false == this.includeStart){
				// 获取下一组元素
				index ++;
				return nextUncheck();
			}
		} else {
			current = next;
			this.next = safeStep(this.next);
		}

		index++;
		return current;
	}

	/**
	 * 不抛异常的获取下一步进的元素，如果获取失败返回{@code null}
	 *
	 * @param base  上一个元素
	 * @return 下一步进
	 */
	private T safeStep(T base) {
		final int index = this.index;
		T next = null;
		try {
			next = stepper.step(base, this.end, index);
		} catch (Exception e) {
			// ignore
		}

		return next;
	}

	@Override
	public void remove() {
		throw new UnsupportedOperationException("Can not remove ranged element!");
	}

	@Override
	public Iterator iterator() {
		return this;
	}

	/**
	 * 重置Range
	 *
	 * @return this
	 */
	public Range reset() {
		lock.lock();
		try {
			this.index = 0;
			this.next = safeStep(this.start);
		} finally {
			lock.unlock();
		}
		return this;
	}

	/**
	 * 步进接口，此接口用于实现如何对一个对象按照指定步进增加步进

	 * 步进接口可以定义以下逻辑：
	 *
	 * 	 * 1、步进规则，即对象如何做步进
	 * 2、步进大小，通过实现此接口，在实现类中定义一个对象属性，可灵活定义步进大小
	 * 3、限制range个数，通过实现此接口，在实现类中定义一个对象属性，可灵活定义limit，限制range个数
	 * 
	 *
	 * @param  需要增加步进的对象
	 * @author Looly
	 */
	@FunctionalInterface
	public interface Stepper {
		/**
		 * 增加步进

		 * 增加步进后的返回值如果为{@code null}则表示步进结束

		 * 用户需根据end参数自行定义边界，当达到边界时返回null表示结束，否则Range中边界对象无效，会导致无限循环
		 *
		 * @param current 上一次增加步进后的基础对象
		 * @param end     结束对象
		 * @param index   当前索引（步进到第几个元素），从0开始计数
		 * @return 增加步进后的对象
		 */
		T step(T current, T end, int index);
	}
}