edu.msoe.jones.huffmantree

Class HuffmanTree

java.lang.Object

edu.msoe.jones.huffmantree.HuffmanTree

All Implemented Interfaces:

java.lang.Comparable<HuffmanTree>

Direct Known Subclasses:

HuffmanTreeUtilities.HuffmanLeaf, HuffmanTreeUtilities.HuffmanNode

public abstract class HuffmanTree
extends java.lang.Object
implements java.lang.Comparable<HuffmanTree>

An abstract class that defines a HuffmanTree

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	frequency An integer that contains the frequency of the character that may be stored in a leaf node of the HuffmanTree

Constructor Summary

Constructors

Constructor and Description
HuffmanTree(int frequency) Constructor that takes a starting frequency

Method Summary

Modifier and Type	Method and Description
int	compareTo(HuffmanTree tree) Method required by Comparable to compare two HuffmanTrees.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

frequency

final int frequency

An integer that contains the frequency of the character that may be stored in a leaf node of the HuffmanTree

Constructor Detail

HuffmanTree

HuffmanTree(int frequency)

Constructor that takes a starting frequency

Parameters:

frequency - The default starting frequency of a node (usually 0 or 1)

Method Detail

compareTo

public int compareTo(HuffmanTree tree)

Method required by Comparable to compare two HuffmanTrees. Implemented by comparing their frequencies

Specified by:

compareTo in interface java.lang.Comparable<HuffmanTree>

Parameters:

tree - The other HuffmanTree being compared

Returns:

0 if the tree contain the same frequency, a positive integer if the current node's frequency is greater than the other node, a negative integer otherwise.