io.rxmicro.rest.ParameterMappingStrategy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rxmicro-rest Show documentation

The basic module that defines basic RxMicro annotations, required when using the REST architecture of building program systems.

There is a newer version: 0.11

Show newest version

/*
 * Copyright (c) 2020. https://rxmicro.io
 *
 * 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
 *
 *     http://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 io.rxmicro.rest;

import io.rxmicro.model.MappingStrategy;

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

import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.SOURCE;

/**
 * Declares a strategy of parameter name formation based on Java model field name analysis.
 * 
 * By default, the {@link MappingStrategy#LOWERCASE_WITH_UNDERSCORED} strategy is used.
 * Thus, by using this strategy, the {@code header_name} name header corresponds to the {@code headerName} field name.
 * 

 * 
The RxMicro framework uses the following algorithm to define the HTTP parameter name for the specified model field:
 * 
 *     
 *         If the field is annotated by the {@link Parameter} annotation with an explicit indication of the HTTP parameter name,
 *         the specified name is used.
 *     
 *     
 *         If no HTTP parameter name is specified in the {@link Parameter} annotation, the RxMicro framework checks for the
 *         {@link ParameterMappingStrategy} annotation above the model class.
 *     
 *     
 *         If the model class is annotated by the  {@link ParameterMappingStrategy} annotation, then the specified naming strategy is used.
 *         (The field name is used as the basic name, and then, following the rules of the specified strategy,
 *         the HTTP parameter name is generated.)
 *     
 *     
 *         If the {@link ParameterMappingStrategy} annotation is missing, the model class field name is used as the HTTP parameter name.
 *     
 * 
 *
 * @author nedis
 * @since 0.1
 * @see AddQueryParameter
 * @see SetQueryParameter
 * @see RepeatQueryParameter
 * @see Parameter
 * @see MappingStrategy
 */
@Documented
@Retention(SOURCE)
@Target({TYPE, METHOD})
public @interface ParameterMappingStrategy {

    /**
     * By default, the {@link MappingStrategy#LOWERCASE_WITH_UNDERSCORED} strategy is used.
     * 
     * Thus, by using this strategy, the {@code header_name} name header corresponds to the {@code headerName} field name.
     *
     * @return the mapping strategy
     */
    MappingStrategy value() default MappingStrategy.LOWERCASE_WITH_UNDERSCORED;
}