File: OptionSupport.java

package info (click to toggle)
openjdk-25 25.0.1%2B8-1~deb13u1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 825,408 kB
  • sloc: java: 5,585,680; cpp: 1,333,948; xml: 1,321,242; ansic: 488,034; asm: 404,003; objc: 21,088; sh: 15,106; javascript: 13,265; python: 8,319; makefile: 2,518; perl: 357; awk: 351; pascal: 103; exp: 83; sed: 72; jsp: 24
file content (76 lines) | stat: -rw-r--r-- 3,031 bytes parent folder | download | duplicates (19)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
/*
 * Copyright (c) 2008, 2018, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package vm.share.options;

/**
 * This class actually provides the OptionFramework API
 * via two static {@link OptionSupport#setup} methods.
 * See also "General description" section of the package level documentation.
 */
public class OptionSupport
{
    /**
     * This method parses the commandline arguments, setups the instance fields (annotated by @Option) accordingly
     * and calls method run().
     * @param test  the instance to setup fields for
     * @param args  command line arguments array
      */
    public static void setupAndRun(Runnable test, String[] args) {
        setupAndRun(test, args, null);
    }

    /**
     * This method parses the commandline arguments and setups the instance fields (annotated by @Option) accordingly
     * @param test  the instance to setup fields for
     * @param args  command line arguments array
     */
    public static void setup(Object test, String[] args)
    {
        setup(test, args, null);
    }

    /**
     * This method parses the commandline arguments, setups the instance fields (annotated by @Option) accordingly
     * and calls method run().
     * @param test  the instance to setup fields for
     * @param args  command line arguments array
     * @param unknownOptionHandler an option handler for unknown options
      */
    public static void setupAndRun(Runnable test, String[] args, OptionHandler unknownOptionHandler) {
        setup(test, args, unknownOptionHandler);
        test.run();
    }


    /**
     *  This is an extension API which allows Test author to create and
     *  process some specific options.
     * @param test  the instance to setup fields for
     * @param args  command line arguments array
     * @param unknownOptionHandler an option handler for unknown options
     *
     */
    public static void setup(Object test, String[] args, OptionHandler unknownOptionHandler) {
                new OptionsSetup(test, args, unknownOptionHandler).run();
    }
}