ru.pocketbyte.locolaser.resource.file.ResourceFile.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2017 Denis Shurygin. All rights reserved.
 * Licensed under the Apache License, Version 2.0
 */

package ru.pocketbyte.locolaser.resource.file

import ru.pocketbyte.locolaser.config.ExtraParams
import ru.pocketbyte.locolaser.resource.entity.ResMap
import ru.pocketbyte.locolaser.resource.formatting.FormattingType

import java.io.*

/**
 * Represent resource file.
 *
 * @author Denis Shurygin
 */
interface ResourceFile {

    val formattingType: FormattingType

    /**
     * Read resources map from the resource file.
     * @return Map with resources.
     */
    fun read(extraParams: ExtraParams?): ResMap?

    /**
     * Write resources map into resource files.
     * @param resMap Map with resources.
     * @throws IOException
     */
    @Throws(IOException::class)
    fun write(resMap: ResMap, extraParams: ExtraParams?)

}