net.grinder.console.editor.AbstractTextSource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grinder-core Show documentation
The Grinder.
The newest version!
// Copyright (C) 2004 - 2009 Philip Aston
// All rights reserved.
//
// This file is part of The Grinder software distribution. Refer to
// the file LICENSE which is part of The Grinder distribution for
// licensing details. The Grinder distribution is available on the
// Internet at http://grinder.sourceforge.net/
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
// COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
// OF THE POSSIBILITY OF SUCH DAMAGE.

package net.grinder.console.editor;

import net.grinder.util.ListenerSupport;


/**
 * Base {@link TextSource} implementation that adds {@link
 * TextSource.Listener} and {@link #isDirty} support. See {@link
 * #setClean} for important subclass responsibilities.
 *
 * @author Philip Aston
 */
public abstract class AbstractTextSource implements TextSource {

  /** We are born into this world dirty. */
  private boolean m_dirty = true;

  private final ListenerSupport m_listeners =
    new ListenerSupport();

  /**
   * Return whether the text has changed since the last call to {@link
   * TextSource#getText} or {@link TextSource#setText}.
   *
   * @return true => the text has changed.
   */
  public boolean isDirty() {
    return m_dirty;
  }

  /**
   * Used by subclasses to mark that the TextSource is
   * clean. Subclasses should call setClean() in their
   * {@link TextSource#setText} and {@link TextSource#getText}
   * implementations.
   *
   */
  protected final void setClean() {
    final boolean oldDirty = m_dirty;
    m_dirty = false;
    fireTextSourceChanged(oldDirty);
  }


  /**
   * Used by subclasses to mark that the TextSource has
   * changed.
   */
  protected final void setChanged() {
    final boolean oldDirty = m_dirty;
    m_dirty = true;
    fireTextSourceChanged(!oldDirty);
  }

    /**
   * Listener registration.
   *
   * @param listener The listener.
   */
  public void addListener(TextSource.Listener listener) {
    m_listeners.add(listener);
  }

  private void fireTextSourceChanged(final boolean firstEdit) {
    m_listeners.apply(
      new ListenerSupport.Informer() {
        public void inform(Listener l) { l.textSourceChanged(firstEdit); }
      });
  }
}