001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.marshall;
018
019import static java.lang.annotation.ElementType.*;
020import static java.lang.annotation.RetentionPolicy.*;
021
022import java.lang.annotation.*;
023
024/**
025 * Used to identify a class or bean property as a URI.
026 *
027 * <p>
028 * Can be used in the following locations:
029 * <ul>
030 *    <li>Classes that should be treated as URIs when serialized.
031 *    <li>Methods/fields whose values should be treated as URIs when serialized.
032 *    <li><ja>@Rest</ja>-annotated classes and <ja>@RestOp</ja>-annotated methods when used with {@link UriApply @UriApply}.
033 * </ul>
034 *
035 * <p>
036 * This annotation allows you to identify other classes that return URIs via <c>toString()</c> as URI objects.
037 *
038 * <h5 class='section'>See Also:</h5><ul>
039 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/MarshallingUris">URIs</a>
040
041 * </ul>
042 */
043@Documented
044@Target({ TYPE, FIELD, METHOD })
045@Retention(RUNTIME)
046@Inherited
047public @interface Uri {
048
049   /**
050    * Optional description for the exposed API.
051    *
052    * @return The annotation value.
053    * @since 9.2.0
054    */
055   String[] description() default {};
056
057}