001/*
002 * (C) Copyright 2006-2010 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     bstefanescu
018 */
019package org.nuxeo.shell;
020
021import java.util.ServiceLoader;
022
023/**
024 * Services implementing this interface will be used to add new features to the shell, like custom command namespaces,
025 * completors etc. Registered (i.e. available) features are exposed by the Shell#getFeatures() method Registration of a
026 * feature implementation is done as described by the Java {@link ServiceLoader} mechanism that is used for service
027 * discovery.
028 *
029 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
030 */
031public interface ShellFeature {
032
033    /**
034     * Install the feature in the given shell instance. This is typically registering new global commands, namespaces,
035     * value adapters or completors.
036     *
037     * @param shell
038     */
039    void install(Shell shell);
040
041}