org.apache.juneau.annotation.URI Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *
// * to you 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 org.apache.juneau.annotation;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*;
import java.lang.annotation.*;
import java.net.*;
import org.apache.juneau.*;
import org.apache.juneau.serializer.*;
/**
* Used to identify a class or bean property as a URI.
*
*
* By default, instances of {@link URL} and {@link URI} are considered URIs during serialization, and are handled
* differently depending on the serializer (e.g. HtmlSerializer creates a hyperlink,
* RdfXmlSerializer creates an rdf:resource object, etc...).
*
*
* This annotation allows you to identify other classes that return URIs via toString() as URI objects.
*
*
* URIs are automatically resolved to absolute or root-relative form based on the serializer
* {@link Serializer#SERIALIZER_uriResolution} and {@link Serializer#SERIALIZER_uriRelativity}
* configuration settings, and the URI context defined by the {@link UriContext} that's part of the serializer
* session.
*
*
* Refer to the {@link UriResolver} class for information about the types of URIs that can be resolved during
* serialization.
*
*
* This annotation can be applied to classes, interfaces, or bean property methods for fields.
*
*
Example:
*
*
* // Applied to a class whose toString() method returns a URI.
* @URI
* public class MyURI {
* @Override
* public String toString() {
* return "http://localhost:9080/foo/bar" ;
* }
* }
*
* // Applied to bean properties
* public class MyBean {
*
* @URI
* public String beanUri ;
*
* @URI
* public String getParentUri() {
* ...
* }
* }
*
*/
@Documented
@Target({TYPE,FIELD,METHOD})
@Retention(RUNTIME)
@Inherited
public @interface URI {}