/*
 * 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.fesod.sheet.cache;

import org.apache.fesod.sheet.context.AnalysisContext;

/**
 * Read cache
 *
 *
 */
public interface ReadCache {

    /**
     * Initialize cache
     *
     * @param analysisContext
     *            A context is the main anchorage point of a excel reader.
     */
    void init(AnalysisContext analysisContext);

    /**
     * Automatically generate the key and put it in the cache.Key start from 0
     *
     * @param value
     *            Cache value
     */
    void put(String value);

    /**
     * Get value
     *
     * @param key
     *            Index
     * @return Value
     */
    String get(Integer key);

    /**
     * It's called when all the values are put in
     */
    void putFinished();

    /**
     * Called when the excel read is complete
     */
    void destroy();
}
