loggersoft.kotlin.utils.AbstractBuffer.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kotlin-utils Show documentation

Helpful extra utils for the kotlin-std library.

There is a newer version: 0.77

/*
 * Copyright (C) 2018 Alexander Kornilov ([email protected])
 *
 * 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 loggersoft.kotlin.utils

/**
 * Represents abstract buffer for I/O operations.
 *
 * @author Alexander Kornilov ([email protected]).
 */
abstract class AbstractBuffer {

    /**
     * Available data in buffer.
     */
    val available: Int
        get() = used - offset

    /**
     * Buffer capacity.
     */
    val capacity: Int
        get() = size - used

    /**
     * Indicates that buffer has any data.
     */
    val hasData: Boolean
        get() = used > 0

    /**
     * Buffer size.
     */
    abstract val size: Int

    /**
     * Current offset in buffer.
     */
    var offset: Int = 0
        set(value) {
            field = when {
                value < 0 -> 0
                value > size -> size
                else -> value
            }
            if (field > used) used = field
        }

    /**
     * Buffer used.
     */
    var used: Int = 0
        set(value) {
            field = when {
                value < 0 -> 0
                value > size -> size
                else -> value
            }
        }

    /**
     * Resets buffer state.
     */
    fun reset() {
        offset = 0
        used = 0
    }
}