source: josm/trunk/src/org/openstreetmap/josm/CLIModule.java @ 13161

Last change on this file since 13161 was 12793, checked in by bastiK, 19 months ago

see #15273, see #15229, see #15182 - add missing class

File size: 815 bytes
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm;
3
4/**
5 * A command line interface module.
6 * <p>
7 * The user can provide an action keyword as first argument. This will invoke the
8 * corresponding {@code CLIModule}, which has its own set of options and will do
9 * a specific job.
10 * @since 12793
11 */
12public interface CLIModule {
13
14    /**
15     * Get the action keyword that the user needs to provide as first command
16     * line argument to invoke this module.
17     * @return the action keyword of this module
18     */
19    String getActionKeyword();
20
21    /**
22     * Process the remaining command line arguments and run any of the requested actions.
23     * @param argArray command line arguments without the initial action keyword
24     */
25    void processArguments(String[] argArray);
26
27}
Note: See TracBrowser for help on using the repository browser.