Package: CommandCompleterRegistry

CommandCompleterRegistry

Coverage

1: /*******************************************************************************
2: * Copyright (c) 2008, 2010 VMware Inc.
3: * All rights reserved. This program and the accompanying materials
4: * are made available under the terms of the Eclipse Public License v1.0
5: * which accompanies this distribution, and is available at
6: * http://www.eclipse.org/legal/epl-v10.html
7: *
8: * Contributors:
9: * VMware Inc. - initial contribution
10: *******************************************************************************/
11:
12: package org.eclipse.virgo.shell.internal.completers;
13:
14: import org.eclipse.virgo.shell.CommandCompleter;
15:
16: /**
17: * A <code>CommandCompleterRegistry</code> provides access to all of the currently available {@link CommandCompleter CommandCompleters}.
18: * <p />
19: *
20: * <strong>Concurrent Semantics</strong><br />
21: *
22: * Implementations must be thread-safe.
23: *
24: */
25: public interface CommandCompleterRegistry {
26:
27: /**
28: * Returns the {@link CommandCompleter} for the command with the given <code>commandName</code>, or
29: * <code>null</code> if no such completer is known to the registry.
30: *
31: * @param commandName The name of the command for which a completer is required
32: * @return The completer for the command
33: */
34: CommandCompleter getCommandCompleter(String commandName);
35:
36: }