org.apache.juneau.html.annotation.HtmlLink 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.html.annotation;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*;
import java.lang.annotation.*;
import org.apache.juneau.html.*;
/**
* Used in conjunction with the {@link HtmlSerializer} class to define hyperlinks.
*
*
* This annotation is applied to classes.
*
*
* Annotation that can be used to specify that a class has a URL associated with it.
*
*
* When rendered using the {@link org.apache.juneau.html.HtmlSerializer HtmlSerializer} class, this class will get
* rendered as a hyperlink like so...
*
* <a href ='hrefProperty' > nameProperty</a>
*
*/
@Documented
@Target(TYPE)
@Retention(RUNTIME)
@Inherited
public @interface HtmlLink {
/**
* The bean property whose value becomes the name in the hyperlink.
*/
String nameProperty() default "name";
/**
* The bean property whose value becomes the url in the hyperlink.
*/
String uriProperty() default "uri";
}