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

Show more of this group Show more artifacts with this name
Show all versions of jasperreports Show documentation
Free Java Reporting Library
There is a newer version: 6.21.2
/*
 * JasperReports - Free Java Reporting Library.
 * Copyright (C) 2001 - 2022 TIBCO Software 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;

/**
 * Virtualization helper class.
 * 
 * @author Lucian Chirita ([email protected])
 */
public final class JRVirtualizationHelper
{
	private static final ThreadLocal threadVirtualizer = new ThreadLocal<>();
	private static final ThreadLocal threadJasperReportsContext = new ThreadLocal<>();

	
	/**
	 * Sets a virtualizer to be used for the current thread.
	 * 
	 * The current thread's virtualizer is used when a report obtained by virtualization
	 * is deserialized.
	 * 
	 * @param virtualizer
	 */
	public static void setThreadVirtualizer(JRVirtualizer virtualizer)
	{
		threadVirtualizer.set(virtualizer);
	}

	
	/**
	 * Clears the virtualizer associated to the current thread.
	 */
	public static void clearThreadVirtualizer()
	{
		threadVirtualizer.remove();
	}

	
	/**
	 * Returns the virtualizer associated to the current thread.
	 * 

	 * This method is used by {@link net.sf.jasperreports.engine.base.JRVirtualPrintPage JRVirtualPrintPage}
	 * on deserialization.
	 * 
	 * @return the virtualizer associated to the current thread
	 */
	public static JRVirtualizer getThreadVirtualizer()
	{
		return threadVirtualizer.get();
	}
	
	
	/**
	 * Sets a JasperReportsContext to be used for the current thread.
	 * 

	 * The current thread's context is used when a report obtained by virtualization
	 * is deserialized.
	 * 
	 * @param jasperReportsContext
	 */
	public static void setThreadJasperReportsContext(JasperReportsContext jasperReportsContext)
	{
		threadJasperReportsContext.set(jasperReportsContext);
	}

	
	/**
	 * Clears the JasperReportsContext associated to the current thread.
	 */
	public static void clearThreadJasperReportsContext()
	{
		threadJasperReportsContext.remove();
	}

	
	/**
	 * Returns the JasperReportsContext associated to the current thread.
	 * 
	 * This method is used by {@link net.sf.jasperreports.engine.base.JRVirtualPrintPage JRVirtualPrintPage}
	 * on deserialization.
	 * 
	 * @return the JasperReportsContext associated to the current thread
	 */
	public static JasperReportsContext getThreadJasperReportsContext()
	{
		return threadJasperReportsContext.get();
	}
	
	
	private JRVirtualizationHelper()
	{
	}
}