/*
 * 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.texera.amber.core.storage.model

/**
  * BufferedItemWriter provides an interface for writing items to a buffer and performing I/O operations.
  * The items are buffered before being written to the underlying storage to optimize performance.
  * @tparam T the type of data items to be written.
  */
trait BufferedItemWriter[T] {

  /**
    * The size of the buffer.
    * @return the buffer size.
    */
  val bufferSize: Int

  /**
    * Open the writer, initializing any necessary resources.
    * This method should be called before any write operations.
    */
  def open(): Unit

  /**
    * Close the writer, flushing any remaining items in the buffer
    * to the underlying storage and releasing any held resources.
    */
  def close(): Unit

  /**
    * Put one item into the buffer. If the buffer is full, it should be flushed to the underlying storage.
    * @param item the data item to be written.
    */
  def putOne(item: T): Unit

  /**
    * Remove one item from the buffer. If the item is not found in the buffer, an appropriate action should be taken,
    * such as throwing an exception or ignoring the request.
    * @param item the data item to be removed.
    */
  def removeOne(item: T): Unit
}
