001/*
002 * (C) Copyright 2006-2010 Nuxeo SAS (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library 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 * Contributors:
015 *     bstefanescu
016 */
017package org.nuxeo.shell;
018
019import java.util.ServiceLoader;
020
021/**
022 * Services implementing this interface will be used to add new features to the shell, like custom command namespaces,
023 * completors etc. Registered (i.e. available) features are exposed by the Shell#getFeatures() method Registration of a
024 * feature implementation is done as described by the Java {@link ServiceLoader} mechanism that is used for service
025 * discovery.
026 *
027 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
028 */
029public interface ShellFeature {
030
031    /**
032     * Install the feature in the given shell instance. This is typically registering new global commands, namespaces,
033     * value adapters or completors.
034     *
035     * @param shell
036     */
037    void install(Shell shell);
038
039}