001    /*
002     * Copyright (C) 2010 eXo Platform SAS.
003     *
004     * This is free software; you can redistribute it and/or modify it
005     * under the terms of the GNU Lesser General Public License as
006     * published by the Free Software Foundation; either version 2.1 of
007     * the License, or (at your option) any later version.
008     *
009     * This software is distributed in the hope that it will be useful,
010     * but WITHOUT ANY WARRANTY; without even the implied warranty of
011     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012     * Lesser General Public License for more details.
013     *
014     * You should have received a copy of the GNU Lesser General Public
015     * License along with this software; if not, write to the Free
016     * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
017     * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
018     */
019    
020    package org.crsh.term;
021    
022    /**
023     * An event emitted by a term.
024     *
025     * @author <a href="mailto:julien.viet@exoplatform.com">Julien Viet</a>
026     * @version $Revision$
027     */
028    public class TermEvent {
029    
030      @Override
031      public String toString() {
032        return getClass().getSimpleName() + "[]";
033      }
034    
035      /**
036       * Signals a control-break.
037       */
038      public static class Close extends TermEvent {
039      }
040    
041      /**
042       * Signals a control-break.
043       */
044      public static class Break extends TermEvent {
045      }
046    
047      /**
048       * Signals the completion of a text line.
049       */
050      public static class Complete extends TermEvent {
051    
052        /** The line to be completed. */
053        private CharSequence line;
054    
055        public Complete(CharSequence line) {
056          this.line = line;
057        }
058    
059        public CharSequence getLine() {
060          return line;
061        }
062    
063        @Override
064        public String toString() {
065          return "Complete[line=" + line + "]";
066        }
067      }
068    
069      /**
070       * Signals a line was submitted for processing.
071       */
072      public static class ReadLine extends TermEvent {
073    
074        /** . */
075        private final CharSequence line;
076    
077        public ReadLine(CharSequence line) {
078          this.line = line;
079        }
080    
081        public CharSequence getLine() {
082          return line;
083        }
084    
085        @Override
086        public String toString() {
087          return "ReadLine[line=" + line + "]";
088        }
089      }
090    }