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 */
019package org.crsh.lang.spi;
020
021import org.crsh.shell.impl.command.ShellSession;
022import org.crsh.shell.impl.command.spi.CommandException;
023
024import java.util.Set;
025
026/**
027 *
028 *
029 * @author Julien Viet
030 */
031public interface Compiler {
032
033  /**
034   * Returns the set of extensions managed by this implementation.
035   *
036   * @return the set of extensions, for instance ("groovy")
037   */
038  Set<String> getExtensions();
039
040  /**
041   * Compile a command..
042   *
043   * @param name the command name
044   * @param source the command source  @return the command or null if no command can be resolved
045   * @throws org.crsh.shell.impl.command.spi.CommandException when the command exists but cannot be created
046   * @throws NullPointerException if the command name is null
047   */
048  CommandResolution compileCommand(String name, byte[] source) throws CommandException, NullPointerException;
049
050  //
051  String doCallBack(ShellSession session, String name, String defaultValue);
052
053}