spring Selector 源码

  • 2022-08-12
  • 浏览 (528)

springboot Selector 代码

文件路径:/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/annotation/Selector.java

/*
 * Copyright 2012-2019 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.boot.actuate.endpoint.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * A {@code @Selector} can be used on a parameter of an {@link Endpoint @Endpoint} method
 * to indicate that the parameter is used to select a subset of the endpoint's data.
 * <p>
 * A {@code @Selector} may change the way that the endpoint is exposed to the user. For
 * example, HTTP mapped endpoints will map select parameters to path variables.
 *
 * @author Andy Wilkinson
 * @since 2.0.0
 */
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Selector {

	/**
	 * The match type that should be used for the selection.
	 * @return the match type
	 * @since 2.2.0
	 */
	Match match() default Match.SINGLE;

	/**
	 * Match types that can be used with the {@code @Selector}.
	 */
	enum Match {

		/**
		 * Capture a single item. For example, in the case of a web application a single
		 * path segment. The parameter value be converted from a {@code String} source.
		 */
		SINGLE,

		/**
		 * Capture all remaining times. For example, in the case of a web application all
		 * remaining path segments. The parameter value be converted from a
		 * {@code String[]} source.
		 */
		ALL_REMAINING

	}

}

相关信息

spring 源码目录

相关文章

spring AbstractDiscoveredEndpoint 源码

spring AbstractDiscoveredOperation 源码

spring DeleteOperation 源码

spring DiscoveredEndpoint 源码

spring DiscoveredOperationMethod 源码

spring DiscoveredOperationsFactory 源码

spring DiscovererEndpointFilter 源码

spring Endpoint 源码

spring EndpointConverter 源码

spring EndpointDiscoverer 源码

0  赞