me.magicall.biz.scope.Scoped Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of support-biz Show documentation

There is a newer version: 2.13.0

/*
 * Copyright (c) 2024 Liang Wenjian
 * magicall is licensed under Mulan PSL v2.
 * You can use this software according to the terms and conditions of the Mulan PSL v2.
 * You may obtain a copy of Mulan PSL v2 at:
 *          http://license.coscl.org.cn/MulanPSL2
 * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
 * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
 * MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 * See the Mulan PSL v2 for more details.
 */

package me.magicall.biz.scope;

import me.magicall.贵阳DearSun.Thing;
import me.magicall.贵阳DearSun.exception.OperationNotAvailableException;
import me.magicall.贵阳DearSun.exception.OperationNotAvailableException.Operator;

/**
 * 实现此接口，表示对象有范围。
 *
 * @author Liang Wenjian.
 */
@FunctionalInterface
public interface Scoped {
	/**
	 * 本物所在范围。
	 *
	 * @return
	 */
	Scope scope();

	/**
	 * 把本物放进一个新范围。若不支持更改范围，可直接返回本对象或抛出异常。
	 * 默认实现为抛出 {@link OperationNotAvailableException}
	 *
	 * @return
	 */
	default Scoped putIn(final Scope newScope) {
		final var scope = scope();
		throw new OperationNotAvailableException(Operator.UNKNOWN, "putIn",
				Thing.of(Scoped.class.getSimpleName(), scope == null ? null : scope.name()));
	}
}