com.ygmodesto.modernfit.annotations.OPTIONS Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of modernfit Show documentation

A compile-time type-safe HTTP client for Android and Java.

The newest version!

/*
 * Copyright 2020 Yago Modesto González Diéguez
 *
 * 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 com.ygmodesto.modernfit.annotations;

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

import com.ygmodesto.modernfit.services.Constants;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/** Make an OPTIONS request. */
@Documented
@Target(METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface OPTIONS {

  /**
   * A relative or absolute path, or full URL of the endpoint. This value is optional if the first
   * parameter of the method is annotated with {@link Url @Url}.
   *
   * See {@linkplain com.ygmodesto.modernfit.annotations.Modernfit#value() base URL} for details
   * of how this is resolved against a base URL to create the full endpoint URL.
   */
  String value() default Constants.EMPTY_STRING;
}