001/*
002 * The MIT License (MIT)
003 *
004 * Copyright (c) 2015-2023 decimal4j (tools4j), Marco Terzer
005 *
006 * Permission is hereby granted, free of charge, to any person obtaining a copy
007 * of this software and associated documentation files (the "Software"), to deal
008 * in the Software without restriction, including without limitation the rights
009 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
010 * copies of the Software, and to permit persons to whom the Software is
011 * furnished to do so, subject to the following conditions:
012 *
013 * The above copyright notice and this permission notice shall be included in all
014 * copies or substantial portions of the Software.
015 *
016 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
017 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
018 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
019 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
020 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
021 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
022 * SOFTWARE.
023 */
024package org.decimal4j.arithmetic;
025
026/**
027 * Helper class to remove all values held by {@link ThreadLocal} variables. This 
028 * may be useful if the library is used in a web service or servlet container.
029 */
030public final class ThreadLocals {
031        
032        /**
033         * Removes all values held by {@link ThreadLocal} variables that are used by 
034         * the decimal4j library. {@link ThreadLocal#remove()} is called on every
035         * variable to make objects held by those variables available for garbage 
036         * collection.
037         */
038        public static final void removeAll() {
039                StringConversion.STRING_BUILDER_THREAD_LOCAL.remove();
040                UnsignedDecimal9i36f.THREAD_LOCAL_1.remove();
041                UnsignedDecimal9i36f.THREAD_LOCAL_2.remove();
042        }
043        
044        // no instances
045        private ThreadLocals() {
046                super();
047        }
048
049}