mnemonic-core/src/main/java/org/apache/mnemonic/MemChunkHolder.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;

import org.apache.mnemonic.resgc.ReclaimContext;

/**
 * holder for a memory chunk.
 * 
 */
public class MemChunkHolder<A extends CommonAllocator<A>> extends MemHolder<A, Long, MemChunkHolder<A>> {

  protected long m_size;

  /**
   * Constructor: initialize with a memory chunk.
   * 
   * @param ar
   *          specify an Allocator for this holder
   * 
   * @param mres
   *          specify a chunk to be holden
   * 
   * @param size
   *          specify the size of this memory chunk
   */
  public MemChunkHolder(A ar, Long mres, long size) {
    super(mres, ar);
    m_size = size;
  }

  /**
   * get the size of its held memory chunk
   * 
   * @return the size
   */
  @Override
  public long getSize() {
    return m_size;
  }

  /**
   * resize its held chunk
   *
   * @param size
   *          specify the new size for its held chunk
   */
  @Override
  public MemChunkHolder<A> resize(long size) {
    return m_allocator.resizeChunk(this, size);
  }

  /**
   * register its held chunk for auto-reclaim
   *
   */
  @Override
  public void registerAutoReclaim() {
    m_allocator.registerChunkAutoReclaim(this);
  }

  /**
   * register its held chunk for auto-reclaim
   *
   * @param rctx
   *          specify a reclaim context to register
   */
  @Override
  public void registerAutoReclaim(ReclaimContext rctx) {
    m_allocator.registerChunkAutoReclaim(this, rctx);
  }
}