net.sf.jasperreports.engine.JRHyperlinkParameter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jasperreports Show documentation

JasperReports Library

The newest version!

/*
 * JasperReports - Free Java Reporting Library.
 * Copyright (C) 2001 - 2023 Cloud Software Group, Inc. All rights reserved.
 * http://www.jaspersoft.com
 *
 * Unless you have purchased a commercial license agreement from Jaspersoft,
 * the following license terms apply:
 *
 * This program is part of JasperReports.
 *
 * JasperReports is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * JasperReports is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with JasperReports. If not, see .
 */
package net.sf.jasperreports.engine;

import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;

import net.sf.jasperreports.engine.design.JRDesignHyperlinkParameter;
import net.sf.jasperreports.engine.xml.JRXmlConstants;

/**
 * A hyperlink parameter, consisting of a name and a value expression.
 * 
 * Hyperlink parameters can be used to parametrize hyperlinks of custom types.
 * 
 * @author Lucian Chirita ([email protected])
 * @see JRHyperlink#getHyperlinkParameters()
 */
@JsonDeserialize(as = JRDesignHyperlinkParameter.class)
public interface JRHyperlinkParameter extends JRCloneable
{
	
	/**
	 * Returns the parameter name.
	 * 
	 * @return the parameter name
	 */
	@JacksonXmlProperty(isAttribute = true)
	String getName();
	
	
	/**
	 * Returns the parameter value expression.
	 * 
	 * @return the parameter value expression
	 */
	@JsonGetter(JRXmlConstants.ELEMENT_expression)
	JRExpression getValueExpression();
	
}