io.rxmicro.rest.method.PATCH 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.method;

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

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

/**
 * Annotation that can be applied to method to signify the method receives a PATCH request.
 * See https://tools.ietf.org/html/rfc5789
 *
 * @author nedis
 * @since 0.1
 * @see DELETE
 * @see GET
 * @see HEAD
 * @see OPTIONS
 * @see POST
 * @see PUT
 * @see io.rxmicro.rest.model.HttpMethod
 * @see HttpMethods
 */
@Documented
@Retention(SOURCE)
@Target(METHOD)
@Repeatable(PATCH.List.class)
public @interface PATCH {

    /**
     * Returns the URI of the route
     *
     * @return the URI of the route
     */
    String value();

    /**
     * Informs how the request parameters must be transferred via HTTP protocol: in the start line or in the request body.
     *
     * @return  {@code true} if HTTP body is used for transferring of http parameters,
     *          {@code false} if parameters are transferred via HTTP query string
     */
    boolean httpBody() default false;

    /**
     * Defines several {@link PATCH} annotations on the same element.
     *
     * @author nedis
     * @since 0.1
     */
    @Documented
    @Retention(SOURCE)
    @Target(METHOD)
    @interface List {

        /**
         * Returns the several {@link PATCH} annotations on the same element.
         *
         * @return the several {@link PATCH} annotations on the same element.
         */
        PATCH[] value();
    }
}