TypeHint.java

/**
 * Copyright © 2006-2016 Web Cohesion (info@webcohesion.com)
 *
 * 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.webcohesion.enunciate.metadata.rs;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Used to give Enunciate a hint about what a JAX-RS resource method returns or accepts as an input parameter.
 *
 * @author Ryan Heaton
 */
@Target (
  { ElementType.PARAMETER, ElementType.METHOD, ElementType.FIELD, ElementType.TYPE }
)
@Retention (
  RetentionPolicy.RUNTIME
)
public @interface TypeHint {

  /**
   * The hint.
   *
   * @return The hint.
   */
  Class<?> value() default NONE.class;

  /**
   * The fully-qualified classname of the hint. (Used in the case that the hint isn't on the classpath of the resource method at build-time.)
   *
   * @return The fully-qualified classname of the hint.
   */
  String qualifiedName() default "##NONE";

  /**
   * Class indicating "no content" for a resource type.
   */
  public static final class NO_CONTENT {}

  public static final class NONE {}
}