package pas.huffman;

import java.io.Serial;
import java.io.Serializable;
import java.util.HashMap;

/**
 * Simple container class that stores a bit sequence representing a Huffman
 * encoded file along with frequency information that may be used to reconstruct
 * the Huffman tree used for the encoding. 
 * 
 * <p>The frequency HashMap maps from bytes to the number of
 * occurrences of those bytes in the source document.
 *
 * @author CS 240 Instructors
 * @version Spring 2025
 *
 */
public class HuffmanSave implements Serializable {

  @Serial
  private static final long serialVersionUID = 3L;

  private BitSequence encoding;
  private HashMap<Byte, Integer> frequencies;

  /**
   * Create a HuffmanSave object from a bit sequence and a frequency HashMap.
   */
  public HuffmanSave(BitSequence encoding, HashMap<Byte, Integer> frequencies) {
    this.encoding = encoding;
    this.frequencies = frequencies;
  }

  /**
   * Return the bit sequence.
   */
  public BitSequence getEncoding() {
    return encoding;
  }

  /**
   * Return the frequency map.
   */
  public HashMap<Byte, Integer> getFrequencies() {
    return frequencies;
  }

}