View Javadoc

1   package org.hyphenType.documentation.rbgenerator;
2   
3   import org.hyphenType.datastructure.Options;
4   import org.hyphenType.datastructure.annotations.ArgumentsObject;
5   import org.hyphenType.datastructure.annotations.Option;
6   import org.hyphenType.datastructure.annotations.OptionValue;
7   import org.hyphenType.datastructure.annotations.SimpleArgument;
8   
9   @ArgumentsObject(description="Creates a resource bundle based on a options interface.")
10  @SuppressWarnings("unchecked")
11  public interface RBGeneratorOptions extends Options {
12  
13      @Option(names={"h", "help"}, description="Shows this help message.")
14      boolean h();
15      
16  //    @Option(names={"r", "readrb"}, description="Reads a resource bundle when loading the options interface. The actual file that will be read will be determined by the options interface.")
17  //    boolean r();
18      
19      @Option(names={"f", "filename"}, description="The name of the file to write the output to. If more than one language is supported, this name will be used as the basis to create the set of files. If no file is given, this tool will output the contents of the resource bundle to the standard output.")
20      boolean f();
21      
22      @OptionValue(option="f", mandatory=true)
23      String fileName();
24      
25      @SimpleArgument(index = 0, description="The options class that will be analyzed.")
26      Class<? extends Options<?>> optionsClass();
27      
28      @SimpleArgument(index = 1, description="The language variants that will be supported. If no variant is provided, it will only write a template for the default variant. This argument is ignored if the -f, --file option is not used.")
29      String[] supportedLanguages();
30  }