mnemonic-core/src/main/java/org/apache/mnemonic/Reclaim.java

/*
 * 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.mnemonic;

/**
 * an interface to reclaim its memory resource.
 *
 */
public interface Reclaim<MRES> {

  /**
   * reclaim specified resources.
   *
   * @param mres
   *          a resource to be reclaimed
   *
   * @param size
   *          the size of resource, it will be set as null if unknown
   *
   * @return <code>true</code> if this resource has been reclaimed by this callback.
   *         <code>false</code> if this resource needs to be claimed by default
   *         reclaimer
   */
  boolean reclaim(MRES mres, Long size);
}