/*
 * 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.lucene.util.fst;

import java.io.IOException;
import org.apache.lucene.store.DataOutput;
import org.apache.lucene.util.Accountable;

/** Abstraction for reading bytes necessary for FST. */
public interface FSTReader extends Accountable {

  /**
   * Get the reverse BytesReader for this FST
   *
   * @return the reverse BytesReader
   */
  FST.BytesReader getReverseBytesReader();

  /**
   * Write this FST to another DataOutput
   *
   * @param out the DataOutput
   * @throws IOException if exception occurred during writing
   */
  void writeTo(DataOutput out) throws IOException;
}
