org.apache.logging.log4j.kit.recycler.Recycler Maven / Gradle / Ivy
The newest version!
/*
* 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.logging.log4j.kit.recycler;
/**
* Contract for recycling strategies.
* This is the primary building block for logging components striving for garbage-free operation.
*
* @param the recyclable type
* @since 3.0.0
*/
public interface Recycler {
/**
* Acquires an instance of V. This may either be a fresh instance of V or a recycled instance of V.
* Recycled instances will be modified by their cleanup function before being returned.
*
* @return an instance of V to be used
*/
V acquire();
/**
* Releases an instance of V. This allows the instance to be recycled and later reacquired for new
* purposes.
*
* @param value an instance of V no longer being used
*/
void release(V value);
}