001/*
002 * Licensed under the Apache License, Version 2.0 (the "License");
003 * you may not use this file except in compliance with the License.
004 * You may obtain a copy of the License at
005 *
006 *     http://www.apache.org/licenses/LICENSE-2.0
007 *
008 * Unless required by applicable law or agreed to in writing, software
009 * distributed under the License is distributed on an "AS IS" BASIS,
010 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
011 * See the License for the specific language governing permissions and
012 * limitations under the License.
013 */
014package org.gbif.api.annotation;
015
016import java.lang.annotation.ElementType;
017import java.lang.annotation.Retention;
018import java.lang.annotation.RetentionPolicy;
019import java.lang.annotation.Target;
020
021/**
022 * Annotation that marks a resource method to throw a NotFoundException (becomes http 404)
023 * when null is returned by the method.
024 */
025@Target(ElementType.METHOD)
026@Retention(RetentionPolicy.RUNTIME)
027public @interface NullToNotFound {
028
029  /**
030   * Resource URI which was not found.
031   */
032  String value() default "/";
033
034  /**
035   * Prepend the resource and method URL mapping to build the NotFound response.
036   */
037  boolean useUrlMapping() default false;
038}