io.rxmicro.rest.RepeatQueryParameter 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.common.meta.SupportedTypes;

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

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.RetentionPolicy.SOURCE;

/**
 * Informs the {@code RxMicro Annotation Processor},
 * that a query parameter model field with array type must be converted to the repeating query parameter.
 * 
 * By default, the RxMicro framework converts header model value as string, separated by the
 * {@value io.rxmicro.http.HttpValues#STRING_ARRAY_DELIMITER} symbol. For example:
 * 

 * {@code ...&queryParameterName=value1|value2|value3&...}
 * 

 * If this annotation is present, result will be:
 * 

 * {@code ...&queryParameterName=value1&queryParameterName=value2&queryParameterName=value3&...}
 * 
 * Supported for REST client HTTP request model only!
 *
 * @author nedis
 * @since 0.1
 * @see io.rxmicro.http.HttpValues
 * @see AddQueryParameter
 * @see SetQueryParameter
 * @see Parameter
 * @see ParameterMappingStrategy
 */
@Documented
@Retention(SOURCE)
@Target({FIELD, METHOD, PARAMETER})
@SupportedTypes({
        String.class
})
public @interface RepeatQueryParameter {

}