com.topologi.diffx.event.lang.Repertory Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of docx4j Show documentation

docx4j is a library which helps you to work with the Office Open XML file format as used in docx documents, pptx presentations, and xlsx spreadsheets.

There is a newer version: 6.1.2

Show newest version

package com.topologi.diffx.event.lang;

import java.util.Hashtable;

import com.topologi.diffx.event.impl.WordEvent;

/**
 * A repertory of words.
 * 
 * Use this class to store word events in order to avoid creating new instances.
 * 
 * @author Christophe Lauret
 * @version 15 December 2004
 */
public final class Repertory {

  /**
   * Where the words are stored.
   */
  private Hashtable storage = new Hashtable();

  /**
   * Creates a new repertoire.  
   */
  public Repertory() {
  }

  /**
   * Adds a new word to this repertory.
   * 
   * @param word The word to be added.
   */
  public void put(String word) {
    this.storage.put(word, new WordEvent(word));
  }

  /**
   * Returns the WordEvent corresponding to the specified word.
   * 
   * @param word The word to be retrieved.
   * 
   * @return The corresponding WordEvent or null.
   */
  public WordEvent get(String word) {
    return (WordEvent)this.storage.get(word);
  }

  /**
   * Returns the WordEvent corresponding to the specified word.
   * 
   * This method will add the word to the repertory if it does not already exist.
   * 
   * @param word The word to be added and retrieved.
   * 
   * @return The corresponding WordEvent.
   */
  public WordEvent update(String word) {
    if (!contains(word))
      this.storage.put(word, new WordEvent(word));
    return (WordEvent)this.storage.get(word);
  }

  /**
   * Returns the true if this repertory contains the specified word.
   * 
   * @param word The word to be searched.
   * 
   * @return true if this repertory contains the word;
   *         false otherwise.
   */
  public boolean contains(String word) {
    return this.storage.containsKey(word);
  }

  /**
   * Returns the number of words in the repertory.
   * 
   * @return The number of words in the repertory.
   */
  public int size() {
    return this.storage.size();
  }

}