JarCastingWhat is Jaci?
Java Annotation Command Interface.
Jaci generates User Interfaces (CLI/GUI) from annotated methods, which can then be embedded into your application.
What is Jaci for?
Jaci is geared towards 2 things:
- Creating debug consoles - A debug console doesn't need to look pretty, it needs to be convenient to work with (at runtime) and convenient to add commands to (at dev time).
- Creating quick, throw-away prototype code - When you just need to quickly test some logic (or learn a new API), just write the logic, add annotations and let Jaci generate the UI.
Example
@CommandPath("example/simple")
public class Example {
private CommandOutput output;
@Command(description = "Does nothing, really.")
public void simpleCommand(@StringParam(value = "str1", accepts = {"a", "b", "c"}) String str1,
@StringParam(value = "str2", acceptsSupplier = "strSupplier", optional = true, defaultValue = "default") String str2,
@IntParam("int") int i,
@DoubleParam(value = "double", optional = true, defaultValueSupplier = "doubleSupplier") double d,
@BoolParam(value = "flag", optional = true) boolean flag,
@EnumParam(value = "enum", nullable=true) SomeEnum enumParam) {
output.message("str1=" + str1 + ", str2=" + str2 + ", i=" + i + ", d=" + d + ", flag=" + flag + ", enumParam=" + enumParam);
}
}
private String[] strSupplier() {
return new String[] {"d", "e", "f"};
}
private double doubleSupplier() {
return 3.5;
}
Let's explain what's going on here:
- Example defines a directory that has 1 command and is mounted at: 'example/simple'.
- There is a private, non-initialized CommandOutput parameter. CommandOutput is the way by which commands send output to the host application. When processing a class, Jaci will inject any fields of the type CommandOutput with an implementing instance.
- The single command that is defined in the class, 'simpleCommand' has 5 parameters:
- A mandatory string called
str1that only accepts the values {a,b,c}. - An optional string called
str2that only accepts the values {d,e,f} (supplied by a supplier method). If the parameter doesn't receive a value, it will have a value ofdefault. - A mandatory int called
int. - An optional double called
double. If the parameter doesn't receive a value, it will have a value of3.5(supplied by a supplier method). - An optional boolean called
flag. - A mandatory Enum param called
enumParam, which is nullable. This parameter must be passed an explicit value that is one of the enum param's legal values, ornull.
- A mandatory string called
- The command then just sends the parameter values to the output (The output instance itself will be injected by the library when it processes the class: Wiki)
Here is how this looks on a LibGdx CLI implementation:
Examples
See the Examples project for examples.
Full Documentation
See the Wiki for full documentation.
Binaries
The binaries depend on your choice of UI-platform:
LibGdx CLI:
Unfortunately, at present (libGdx 1.8), the libGdx reflection API does not support parameter annotations. Unsupported parameter annotations mean that it is impossible to give names to command parameters, mark them as optional with default values (all parameters will be considered mandatory) or constrain their accepted values. Since parameter annotations are a big part of the library, and this only potentially affects GWT, it was decided to create 2 jaci-libgdx distributions:
jaci-libgdx-cli-java
Uses the Java reflection API. Supports full reflection capabilities (including parameter annotations), but does not compile with GWT. Use this if you want full support for Jaci's capabilities and aren't using GWT backend.
compile "com.github.ykrasik:jaci-libgdx-cli-java:0.4.0"
jaci-libgdx-cli-gwt
Uses the libGdx reflection API. Does not support parameter annotations (they will be ignored), but compiles with GWT. Use this if you use GWT as a backend.
compile "com.github.ykrasik:jaci-libgdx-cli-gwt:0.4.0"
In your .gwt.xml file, add the following:
<inherits name='com.github.ykrasik.jaci' />
All jars come with source code packaged in the jar, so no other dependencies are required.
Change log
See Change Log
License
Copyright 2014 Yevgeny Krasik.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.