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