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 package org.crsh.command;
020
021 /**
022 * A command invoker.
023 *
024 * @param <C> the consumed generic type
025 * @param <P> the produced generic type
026 */
027 public interface CommandInvoker<C, P> {
028
029 /**
030 * Returns the class of the produced type.
031 *
032 * @return the produced type
033 */
034 Class<P> getProducedType();
035
036 /**
037 * Returns the class of the consumed type.
038 *
039 * @return the consumed type
040 */
041 Class<C> getConsumedType();
042
043 /**
044 * Invoke a command
045 *
046 * @param context the command execution context
047 * @throws ScriptException any script exception
048 * @return the related pipe
049 */
050 PipeCommand<C> invoke(InvocationContext<P> context) throws ScriptException;
051
052 }