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