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.lang.spi;
020    
021    import org.crsh.shell.impl.command.ShellSession;
022    
023    /**
024     * Integration of a language.
025     *
026     * @author Julien Viet
027     */
028    public interface Language {
029    
030      /**
031       * @return the language name
032       */
033      String getName();
034    
035      /**
036       * @return the language display name, including the version if possible
037       */
038      String getDisplayName();
039    
040      /**
041       * @return true if this language is active. Implementation can decide based on the runtime, for instance the
042       *         Groovy language can be inactive when the Groovy runtime is not available
043       */
044      boolean isActive();
045    
046      /**
047       * @return the repl for this language, null should be returned when the language does not support the repl feature
048       */
049      Repl getRepl();
050    
051      /**
052       * @return the compiler for this language, null should be returned when the language does not support the compilation feature
053       */
054      Compiler getCompiler();
055    
056      /**
057       * Init session callback.
058       *
059       * @param session the initialized session
060       */
061      void init(ShellSession session);
062    
063      /**
064       * Destroy session callback.
065       *
066       * @param session the destroyed session
067       */
068      void destroy(ShellSession session);
069    
070    }