org.crsh.term.TermEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of crash.shell Show documentation
The Shell module
There is a newer version: 1.3.2
/*
 * Copyright (C) 2012 eXo Platform SAS.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.crsh.term;

public abstract class TermEvent {

  public static Complete complete(CharSequence line) {
    return new Complete(line);
  }

  public static Close close() {
    return Close.INSTANCE;
  }

  public static ReadLine readLine(CharSequence line) {
    return new ReadLine(line);
  }

  public static Break brk() {
    return Break.INSTANCE;
  }

  private TermEvent() {
  }

  @Override
  public String toString() {
    return getClass().getSimpleName() + "[]";
  }

  /**
   * Signals a control-break.
   */
  public static class Close extends TermEvent {

    /** . */
    private static final Close INSTANCE = new Close();

    private Close() {
    }
  }

  /**
   * Signals a control-break.
   */
  public static class Break extends TermEvent {

    /** . */
    private static final Break INSTANCE = new Break();

    private Break() {
    }
  }

  /**
   * Signals the completion of a text line.
   */
  public static class Complete extends TermEvent {

    /** The line to be completed. */
    private CharSequence line;

    private Complete(CharSequence line) {
      this.line = line;
    }

    public CharSequence getLine() {
      return line;
    }

    @Override
    public String toString() {
      return "Complete[line=" + line + "]";
    }
  }

  /**
   * Signals a line was submitted for processing.
   */
  public static class ReadLine extends TermEvent {

    /** . */
    private final CharSequence line;

    private ReadLine(CharSequence line) {
      this.line = line;
    }

    public CharSequence getLine() {
      return line;
    }

    @Override
    public String toString() {
      return "ReadLine[line=" + line + "]";
    }
  }
}