1 /*
2 * #%L
3 * prolobjectlink-jpi
4 * %%
5 * Copyright (C) 2019 Prolobjectlink Project
6 * %%
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 * THE SOFTWARE.
24 * #L%
25 */
26 package io.github.prolobjectlink.prolog;
27
28 import java.util.Map;
29
30 /**
31 * Represent the prolog console of the system.
32 *
33 * @author Jose Zalacain
34 * @since 1.0
35 */
36 public interface PrologConsole {
37
38 /**
39 * Create a arguments map from a given string arguments array. Used for convert
40 * command line interface program arguments array to argument map.
41 *
42 * @param args string arguments array
43 * @return arguments map
44 * @since 1.0
45 */
46 public Map<String, String> getArguments(String[] args);
47
48 /**
49 * <p>
50 * Command line interface program run method for this platform. Take the program
51 * arguments from main entry point and execute the job. Used like:
52 * </p>
53 *
54 * <pre>
55 * public class ANYPrologConsole extends AbstractConsole implements PrologConsole {
56 * public static void main(String[] args) {
57 * new ANYPrologConsole().run(args);
58 * }
59 *
60 * }
61 * </pre>
62 *
63 * @param args command line interface program arguments array
64 * @since 1.0
65 */
66 public void run(String[] args);
67
68 /**
69 * Used to print console usage.
70 *
71 * @since 1.0
72 */
73 public void printUsage();
74
75 }