001    /*
002     * Copyright (C) 2012 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.command;
021    
022    import org.crsh.Pipe;
023    
024    import java.io.IOException;
025    
026    /**
027     * A pipe command.
028     *
029     * @param <E> the element generic type
030     */
031    public abstract class PipeCommand<E> implements Pipe<E> {
032    
033      /** . */
034      private boolean piped;
035    
036      public final boolean isPiped() {
037        return piped;
038      }
039    
040      public final void setPiped(boolean piped) {
041        this.piped = piped;
042      }
043    
044      /**
045       * Open pipe.
046       */
047      public void open() throws ScriptException {
048      }
049    
050      /**
051       * Extends the throw clause of the {@link Pipe#provide(Object)} method.
052       *
053       * @param element the provided element
054       * @throws ScriptException any script exception
055       * @throws IOException any io exception
056       */
057      public void provide(E element) throws ScriptException, IOException {
058      }
059    
060      /**
061       * Flush pipe.
062       *
063       * @throws ScriptException any script exception
064       * @throws IOException any io exception
065       */
066      public void flush() throws ScriptException, IOException {
067      }
068    
069      /**
070       * Close pipe.
071       *
072       * @throws ScriptException any script exception
073       */
074      public void close() throws ScriptException {
075      }
076    }