dorkbox.cabParser.extractor.CabFileSaver.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of CabParser Show documentation

Parse and extract data from inside Microsoft .cab files, specifically those compressed with LZX, for java.

The newest version!

/*
 * Copyright 2023 dorkbox, llc
 *
 * Licensed 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 dorkbox.cabParser.extractor

import dorkbox.cabParser.structure.CabFileEntry
import java.io.ByteArrayOutputStream

/**
 * To define how to handle (save) the file content, corresponding to each
 * individual file extracted from CAB.
 */
interface CabFileSaver {
    /**
     * Save the extracted file content.
     *
     * @param fileContent extracted file content
     * @param cabFile [CabFileEntry], file to be saved
     */
    fun save(fileContent: ByteArrayOutputStream?, cabFile: CabFileEntry?)

    /**
     * @return amount successfully saved files
     */
    val succeeded: Int

    /**
     * @return amount of failed save attempts
     */
    val failed: Int
}