spring-graphql Argument 源码

  • 2022-08-16
  • 浏览 (658)

spring-graphql Argument 代码

文件路径:/spring-graphql/src/main/java/org/springframework/graphql/data/method/annotation/Argument.java

/*
 * Copyright 2002-2021 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.graphql.data.method.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;

import org.springframework.core.annotation.AliasFor;
import org.springframework.validation.BindException;

/**
 * Annotation to bind a named GraphQL
 * {@link graphql.schema.DataFetchingEnvironment#getArgument(String) argument}
 * onto a method parameter.
 *
 * <p>Binding is performed by mapping argument values to a primary data
 * constructor of the expected method parameter type, or by using a default
 * constructor to create it and then map values to its properties. This is
 * applied recursively, using all nested values and creating nested target
 * objects.
 *
 * <p>If binding fails, a {@link BindException} is raised with binding issues
 * accumulated as {@link BindException#getFieldErrors() field errors} where the
 * {@code field} of each error is the argument path where the issue occurred.
 *
 * <p>If the method parameter is {@link java.util.Map Map&lt;String, Object&gt;}
 * and a parameter name is not specified, then the resolves value is the raw
 * {@link graphql.schema.DataFetchingEnvironment#getArguments() arguments} map.
 *
 * <p>Note that this annotation has neither a "required" flag nor the option to
 * specify a default value, both of which can be specified at the GraphQL schema
 * level and are enforced by the GraphQL Java engine.
 *
 * @author Rossen Stoyanchev
 * @since 1.0.0
 * @see Arguments
 */
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Argument {

	/**
	 * Alias for {@link #name}.
	 */
	@AliasFor("name")
	String value() default "";

	/**
	 * The name of the input argument to bind to.
	 */
	@AliasFor("value")
	String name() default "";

}

相关信息

spring-graphql 源码目录

相关文章

spring-graphql Arguments 源码

spring-graphql BatchMapping 源码

spring-graphql ContextValue 源码

spring-graphql LocalContextValue 源码

spring-graphql MutationMapping 源码

spring-graphql QueryMapping 源码

spring-graphql SchemaMapping 源码

spring-graphql SubscriptionMapping 源码

spring-graphql package-info 源码

0  赞