10 | * Created by Ahmed Adel Ismail on 9/9/2017.
11 | */
12 | class CommandsMapInitializer {
13 |
14 | public static final String GENERATED_NAME = "$$CommandsMap";
15 |
16 | /**
17 | * create a {@link CommandsMap} from the passed instance
18 | *
19 | * @param commandsMapFactory an Object that is annotated with {@link CommandsMapFactory}
20 | * @return a {@link CommandsMap} that holds all the methods annotated with {@link com.annotations.Command}
21 | * @throws IllegalArgumentException if the passed instance is not annotated with {@link CommandsMapFactory}
22 | */
23 | public static CommandsMap of(Object commandsMapFactory) throws IllegalArgumentException {
24 |
25 | Class commandsMapFactoryClass = commandsMapFactory.getClass();
26 |
27 | if (commandsMapFactoryClass.getAnnotation(CommandsMapFactory.class) == null) {
28 | throw new IllegalArgumentException("passed Object should be annotated with @"
29 | + CommandsMapFactory.class.getSimpleName());
30 | }
31 |
32 | String commandsMapName = commandsMapFactoryClass.getName() + GENERATED_NAME;
33 | CommandsMap commandsMap = createCommandsMap(commandsMapName);
34 | commandsMap.setCommandsMapFactory(commandsMapFactory);
35 | return commandsMap;
36 | }
37 |
38 | private static CommandsMap createCommandsMap(String commandsMapName)
39 | throws IllegalArgumentException {
40 | try {
41 | Class clazz = Class.forName(commandsMapName);
42 | Constructor constructor = clazz.getDeclaredConstructor();
43 | constructor.setAccessible(true);
44 | return (CommandsMap) constructor.newInstance();
45 | } catch (Exception e) {
46 | throw new IllegalArgumentException("failed to initialize " + commandsMapName
47 | + ", try to re-build the project");
48 | }
49 | }
50 |
51 | }
52 |
--------------------------------------------------------------------------------
/.idea/misc.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
25 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
1 | @if "%DEBUG%" == "" @echo off
2 | @rem ##########################################################################
3 | @rem
4 | @rem Gradle startup script for Windows
5 | @rem
6 | @rem ##########################################################################
7 |
8 | @rem Set local scope for the variables with windows NT shell
9 | if "%OS%"=="Windows_NT" setlocal
10 |
11 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
12 | set DEFAULT_JVM_OPTS=
13 |
14 | set DIRNAME=%~dp0
15 | if "%DIRNAME%" == "" set DIRNAME=.
16 | set APP_BASE_NAME=%~n0
17 | set APP_HOME=%DIRNAME%
18 |
19 | @rem Find java.exe
20 | if defined JAVA_HOME goto findJavaFromJavaHome
21 |
22 | set JAVA_EXE=java.exe
23 | %JAVA_EXE% -version >NUL 2>&1
24 | if "%ERRORLEVEL%" == "0" goto init
25 |
26 | echo.
27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
28 | echo.
29 | echo Please set the JAVA_HOME variable in your environment to match the
30 | echo location of your Java installation.
31 |
32 | goto fail
33 |
34 | :findJavaFromJavaHome
35 | set JAVA_HOME=%JAVA_HOME:"=%
36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
37 |
38 | if exist "%JAVA_EXE%" goto init
39 |
40 | echo.
41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
42 | echo.
43 | echo Please set the JAVA_HOME variable in your environment to match the
44 | echo location of your Java installation.
45 |
46 | goto fail
47 |
48 | :init
49 | @rem Get command-line arguments, handling Windowz variants
50 |
51 | if not "%OS%" == "Windows_NT" goto win9xME_args
52 | if "%@eval[2+2]" == "4" goto 4NT_args
53 |
54 | :win9xME_args
55 | @rem Slurp the command line arguments.
56 | set CMD_LINE_ARGS=
57 | set _SKIP=2
58 |
59 | :win9xME_args_slurp
60 | if "x%~1" == "x" goto execute
61 |
62 | set CMD_LINE_ARGS=%*
63 | goto execute
64 |
65 | :4NT_args
66 | @rem Get arguments from the 4NT Shell from JP Software
67 | set CMD_LINE_ARGS=%$
68 |
69 | :execute
70 | @rem Setup the command line
71 |
72 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
73 |
74 | @rem Execute Gradle
75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
76 |
77 | :end
78 | @rem End local scope for the variables with windows NT shell
79 | if "%ERRORLEVEL%"=="0" goto mainEnd
80 |
81 | :fail
82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
83 | rem the _cmd.exe /c_ return code!
84 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
85 | exit /b 1
86 |
87 | :mainEnd
88 | if "%OS%"=="Windows_NT" endlocal
89 |
90 | :omega
91 |
--------------------------------------------------------------------------------
/CommandMapsCompiler/src/main/java/com/compiler/Processing.java:
--------------------------------------------------------------------------------
1 | package com.compiler;
2 |
3 | import com.annotations.CommandsMapFactory;
4 |
5 | import java.util.HashSet;
6 | import java.util.Set;
7 |
8 | import javax.annotation.processing.ProcessingEnvironment;
9 | import javax.annotation.processing.RoundEnvironment;
10 | import javax.lang.model.element.Element;
11 | import javax.lang.model.element.ElementKind;
12 | import javax.lang.model.element.TypeElement;
13 | import javax.tools.Diagnostic;
14 |
15 | import io.reactivex.Observable;
16 | import io.reactivex.annotations.NonNull;
17 | import io.reactivex.functions.BiPredicate;
18 | import io.reactivex.functions.Consumer;
19 | import io.reactivex.functions.Function;
20 | import io.reactivex.functions.Predicate;
21 |
22 | /**
23 | * a class that handles processing annotations
24 | *
25 | * Created by Ahmed Adel Ismail on 6/25/2017.
26 | */
27 | class Processing implements BiPredicate, RoundEnvironment> {
28 |
29 | private final ProcessingEnvironment environment;
30 |
31 |
32 | Processing(ProcessingEnvironment environment) {
33 | this.environment = environment;
34 | }
35 |
36 | @Override
37 | public boolean test(Set typeElements, RoundEnvironment round) {
38 | Set elements = round.getElementsAnnotatedWith(CommandsMapFactory.class);
39 | if (elements == null) elements = new HashSet<>();
40 |
41 | Observable.fromIterable(elements)
42 | .filter(byClassElement())
43 | .map(toTypeElement())
44 | .subscribe(new CommandMapGenerator(environment), printErrorInMessager(environment));
45 | return false;
46 | }
47 |
48 |
49 | private static Predicate byClassElement() {
50 | return new Predicate() {
51 | @Override
52 | public boolean test(@NonNull Element element) throws Exception {
53 | return element.getKind().equals(ElementKind.CLASS);
54 | }
55 | };
56 | }
57 |
58 | private static Function toTypeElement() {
59 | return new Function() {
60 | @Override
61 | public TypeElement apply(@NonNull Element element) throws Exception {
62 | return TypeElement.class.cast(element);
63 | }
64 | };
65 | }
66 |
67 |
68 | private static Consumer printErrorInMessager(final ProcessingEnvironment environment) {
69 | return new Consumer() {
70 | @Override
71 | public void accept(@NonNull Throwable throwable) throws Exception {
72 | environment.getMessager()
73 | .printMessage(Diagnostic.Kind.ERROR, throwable.getMessage());
74 | }
75 | };
76 | }
77 |
78 |
79 | }
80 |
--------------------------------------------------------------------------------
/CommandMaps/src/main/java/com/mapper/CommandsMap.java:
--------------------------------------------------------------------------------
1 | package com.mapper;
2 |
3 | import com.annotations.CommandsMapFactory;
4 |
5 | import java.util.LinkedHashMap;
6 |
7 | /**
8 | * a map of commands that can be executed based on a key for each one, to create an instance of
9 | * this class, you should invoke the static {@link #of(Object)} method, where it will scan for all methods annotated
10 | * with {@link com.annotations.Command}, and will store the {@link com.annotations.Command#value()}
11 | * as a key, and the annotated method as a value to be executed through {@link #execute(Object)},
12 | * {@link #execute(Object, Object)}, or {@link #execute(Object, Object, Object)} (based on the number of
13 | * arguments for the method)
14 | *
15 | * notice that the instance that holds the annotated methods should be annotated with
16 | * {@link CommandsMapFactory}, also notice that all this is done in compile time (not reflections),
17 | * so you should build the project before invoking {@link #of(Object)} for the generated class to
18 | * be available
19 | *
20 | * Created by Ahmed Adel Ismail on 9/9/2017.
21 | */
22 | public class CommandsMap extends CommandsMapInitializer {
23 |
24 | private final LinkedHashMap commands = new LinkedHashMap<>();
25 | private final LinkedHashMap biCommands = new LinkedHashMap<>();
26 | private Object commandsMapFactory;
27 |
28 | /**
29 | * set the instance that is annotated with {@link CommandsMapFactory}
30 | *
31 | * @param commandsMapFactory the instance that holds the methods to be added in the
32 | * {@link CommandsMap}
33 | */
34 | public final void setCommandsMapFactory(Object commandsMapFactory) {
35 | this.commandsMapFactory = commandsMapFactory;
36 | }
37 |
38 | @SuppressWarnings("unchecked")
39 | protected final T getHostObject() {
40 | if (commandsMapFactory != null) {
41 | return (T) commandsMapFactory;
42 | } else {
43 | return null;
44 | }
45 | }
46 |
47 | protected void addCommand(Object key, Command command) {
48 | commands.put(key, command);
49 | }
50 |
51 | protected void addBiCommand(Object key, BiCommand biCommand) {
52 | biCommands.put(key, biCommand);
53 | }
54 |
55 | /**
56 | * execute a method that was annotated with {@link com.annotations.Command} and has no parameters
57 | *
58 | * @param key the value that was set in the {@link com.annotations.Command} annotation
59 | */
60 | public final void execute(Object key) {
61 | execute(key, null);
62 | }
63 |
64 | /**
65 | * execute a method that was annotated with {@link com.annotations.Command} and has one parameter
66 | *
67 | * @param key the value that was set in the {@link com.annotations.Command} annotation
68 | * @param parameter the parameter to pass to the target method
69 | * @throws IllegalArgumentException if the key passed is not mapped to any methods (
70 | * not mentioned in the {@link com.annotations.Command} annotation
71 | */
72 | public final void execute(Object key, Object parameter) {
73 | if (commands.containsKey(key)) {
74 | commands.get(key).accept(parameter);
75 | } else if (biCommands.containsKey(key)) {
76 | try {
77 | biCommands.get(key).accept(parameter, null);
78 | } catch (Throwable e) {
79 | e.printStackTrace();
80 | }
81 | } else {
82 | System.err.println("no command assigned to the passed key " + key);
83 | }
84 | }
85 |
86 | /**
87 | * execute a method that was annotated with {@link com.annotations.Command} and has two parameter
88 | *
89 | * @param key the value that was set in the {@link com.annotations.Command} annotation
90 | * @param parameterOne the first parameter to pass to the target method
91 | * @param parameterTwo the second parameter to pass to the target method
92 | * @throws IllegalArgumentException if the key passed is not mapped to any methods (
93 | * not mentioned in the {@link com.annotations.Command} annotation
94 | */
95 | public final void execute(Object key, Object parameterOne, Object parameterTwo) {
96 | if (biCommands.containsKey(key)) {
97 | biCommands.get(key).accept(parameterOne, parameterTwo);
98 | } else if (commands.containsKey(key)) {
99 | commands.get(key).accept(parameterOne);
100 | } else {
101 | System.err.println("no command assigned to the passed key " + key);
102 | }
103 | }
104 |
105 | /**
106 | * clear the current {@link CommandsMap}, this method is important to clear all the references
107 | */
108 | public final void clear() {
109 | commands.clear();
110 | biCommands.clear();
111 | commandsMapFactory = null;
112 | }
113 | }
114 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | ##############################################################################
4 | ##
5 | ## Gradle start up script for UN*X
6 | ##
7 | ##############################################################################
8 |
9 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
10 | DEFAULT_JVM_OPTS=""
11 |
12 | APP_NAME="Gradle"
13 | APP_BASE_NAME=`basename "$0"`
14 |
15 | # Use the maximum available, or set MAX_FD != -1 to use that value.
16 | MAX_FD="maximum"
17 |
18 | warn ( ) {
19 | echo "$*"
20 | }
21 |
22 | die ( ) {
23 | echo
24 | echo "$*"
25 | echo
26 | exit 1
27 | }
28 |
29 | # OS specific support (must be 'true' or 'false').
30 | cygwin=false
31 | msys=false
32 | darwin=false
33 | case "`uname`" in
34 | CYGWIN* )
35 | cygwin=true
36 | ;;
37 | Darwin* )
38 | darwin=true
39 | ;;
40 | MINGW* )
41 | msys=true
42 | ;;
43 | esac
44 |
45 | # Attempt to set APP_HOME
46 | # Resolve links: $0 may be a link
47 | PRG="$0"
48 | # Need this for relative symlinks.
49 | while [ -h "$PRG" ] ; do
50 | ls=`ls -ld "$PRG"`
51 | link=`expr "$ls" : '.*-> \(.*\)$'`
52 | if expr "$link" : '/.*' > /dev/null; then
53 | PRG="$link"
54 | else
55 | PRG=`dirname "$PRG"`"/$link"
56 | fi
57 | done
58 | SAVED="`pwd`"
59 | cd "`dirname \"$PRG\"`/" >/dev/null
60 | APP_HOME="`pwd -P`"
61 | cd "$SAVED" >/dev/null
62 |
63 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
64 |
65 | # Determine the Java command to use to start the JVM.
66 | if [ -n "$JAVA_HOME" ] ; then
67 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
68 | # IBM's JDK on AIX uses strange locations for the executables
69 | JAVACMD="$JAVA_HOME/jre/sh/java"
70 | else
71 | JAVACMD="$JAVA_HOME/bin/java"
72 | fi
73 | if [ ! -x "$JAVACMD" ] ; then
74 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
75 |
76 | Please set the JAVA_HOME variable in your environment to match the
77 | location of your Java installation."
78 | fi
79 | else
80 | JAVACMD="java"
81 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
82 |
83 | Please set the JAVA_HOME variable in your environment to match the
84 | location of your Java installation."
85 | fi
86 |
87 | # Increase the maximum file descriptors if we can.
88 | if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then
89 | MAX_FD_LIMIT=`ulimit -H -n`
90 | if [ $? -eq 0 ] ; then
91 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
92 | MAX_FD="$MAX_FD_LIMIT"
93 | fi
94 | ulimit -n $MAX_FD
95 | if [ $? -ne 0 ] ; then
96 | warn "Could not set maximum file descriptor limit: $MAX_FD"
97 | fi
98 | else
99 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
100 | fi
101 | fi
102 |
103 | # For Darwin, add options to specify how the application appears in the dock
104 | if $darwin; then
105 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
106 | fi
107 |
108 | # For Cygwin, switch paths to Windows format before running java
109 | if $cygwin ; then
110 | APP_HOME=`cygpath --path --mixed "$APP_HOME"`
111 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
112 | JAVACMD=`cygpath --unix "$JAVACMD"`
113 |
114 | # We build the pattern for arguments to be converted via cygpath
115 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
116 | SEP=""
117 | for dir in $ROOTDIRSRAW ; do
118 | ROOTDIRS="$ROOTDIRS$SEP$dir"
119 | SEP="|"
120 | done
121 | OURCYGPATTERN="(^($ROOTDIRS))"
122 | # Add a user-defined pattern to the cygpath arguments
123 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then
124 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
125 | fi
126 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
127 | i=0
128 | for arg in "$@" ; do
129 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
130 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
131 |
132 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
133 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
134 | else
135 | eval `echo args$i`="\"$arg\""
136 | fi
137 | i=$((i+1))
138 | done
139 | case $i in
140 | (0) set -- ;;
141 | (1) set -- "$args0" ;;
142 | (2) set -- "$args0" "$args1" ;;
143 | (3) set -- "$args0" "$args1" "$args2" ;;
144 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
145 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
146 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
147 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
148 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
149 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
150 | esac
151 | fi
152 |
153 | # Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules
154 | function splitJvmOpts() {
155 | JVM_OPTS=("$@")
156 | }
157 | eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS
158 | JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME"
159 |
160 | exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@"
161 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # CommandsMap
2 |
3 | A library that helps avoiding the "switch/case" or "if/else" massive blocks through a table lookup technique, where every block of code is put in a separate method annotated with @Command annotation, this @Command annotation holds the key to lookup for this method in a "key/method" map ... if the value to look up for matches the mentioned key, the method is invoked ... all is done in compile time, no reflections used
4 |
5 | # How to use
6 |
7 | Using the if/else style :
8 |
9 |
10 | public class TestActivity extends AppCompatActivity{
11 | ...
12 | public void onClick(View v){
13 | if(v.getId() == R.id.recyclerView){
14 | // do recycler view stuff
15 | }else if(v.getId() == R.id.card_view){
16 | // do card view stuff
17 | }else if(v.getId() == R.id.info_text){
18 | // do info text stuff
19 | }else if(v.getId() == R.id.progressBar){
20 | // do progress bar stuff
21 | }
22 | }
23 | }
24 |
25 |
26 | Using the CommandsMap :
27 |
28 | @CommandsMapFactory
29 | public class TestActivity extends AppCompatActivity{
30 |
31 | private CommandsMap commandsMap = CommandsMap.of(this);
32 |
33 | ...
34 | public void onClick(View v){
35 | commandsMap.execute(v.getId(),v);
36 | }
37 |
38 | @Command(R.id.recyclerView)
39 | void doRecyclerViewStuff(View view) {
40 | // code goes here
41 | }
42 |
43 | @Command(R.id.card_view)
44 | void doCardViewStuff(View view) {
45 | // code goes here
46 | }
47 |
48 | @Command(R.id.info_text)
49 | void doInfoTextStuff(View view) {
50 | // code goes here
51 | }
52 |
53 | @Command(R.id.progressBar)
54 | void doProgressBarStuff(View view) {
55 | // code goes here
56 | }
57 |
58 | protected void onDestroy() {
59 | commandsMap.clear();
60 | super.onDestroy();
61 | }
62 | }
63 |
64 |
65 | now we have no if/else blocks, no big methods that keeps growing bigger, every block of code stays in a separate method
66 |
67 | # How does things work
68 |
69 | The CommandsMap is generated at Compile time, where the annotation-processor scans for classes with @CommandsMapFactory, and then it scans for methods with @Command annotation, then it generates a Map, where it's key is the Object set in the @Command annotation (like R.id.recyclerView), and the value mapped to this key is the method itself ...
70 |
71 | when we invoke "commandsMap.execute(key, methodParameter)", it searches for the method mapped to the passed key, if found, it passes "methodParameter" to this method
72 |
73 | # No Reflections used
74 |
75 | Every thing goes at compile time, only the method CommandsMap.of() uses reflections to find the generated class for you, which can be done manually as well ... a full example is as follows :
76 |
77 |
78 | @CommandsMapFactory
79 | public class TestActivity extends AppCompatActivity {
80 |
81 | private static final String TAG = TestActivity.class.getSimpleName();
82 | private CommandsMap commandsMap;
83 |
84 | public TestActivity() {
85 |
86 | // initializing with reflections
87 | commandsMap = CommandsMap.of(this);
88 |
89 | // initializing without reflections :
90 | commandsMap = new com.tere.playground.apt.TestActivity$$CommandsMap();
91 | commandsMap.setCommandsMapFactory(this);
92 |
93 | }
94 |
95 | @Override
96 | protected void onCreate(@Nullable Bundle savedInstanceState) {
97 | super.onCreate(savedInstanceState);
98 | setContentView(R.layout.activity_main);
99 |
100 | // invoke printZero()
101 | commandsMap.execute("0");
102 |
103 | // invoke printOne(String)
104 | commandsMap.execute(1L, "test >>> 1");
105 |
106 | // invoke printTwo(String, String)
107 | commandsMap.execute(2, "test >>> 2", "<<<<<");
108 |
109 | // notice that CommandsMap supports different types of keys,
110 | // like Strings, Integers, Longs, etc...
111 | }
112 |
113 | @Command(keyString = "0")
114 | void printZero() {
115 | Log.d(TAG, "printZero()");
116 | }
117 |
118 | @Command(keyLong = 1L)
119 | void printOne(String s) {
120 | Log.e(TAG, s);
121 | }
122 |
123 | @Command(2)
124 | void printTwo(String s1, String s2) {
125 | Log.e(TAG, s1 + s2);
126 | }
127 |
128 |
129 | @Override
130 | protected void onDestroy() {
131 | commandsMap.clear();
132 | super.onDestroy();
133 | }
134 | }
135 |
136 | This library is fully aplicabble with any Java Project, the examples are for Android Activity, but it can be done in any Java module as well
137 |
138 | # Add Gradle Dependency
139 |
140 | Step 1. Add the JitPack repository to your build file
141 |
142 | Add it in your root build.gradle at the end of repositories:
143 |
144 | allprojects {
145 | repositories {
146 | ...
147 | maven { url 'https://jitpack.io' }
148 | }
149 | }
150 |
151 | Step 2. Add the dependency
152 |
153 | dependencies {
154 | implementation 'com.github.Ahmed-Adel-Ismail.CommandsMap:CommandMaps:1.0.0'
155 | annotationProcessor 'com.github.Ahmed-Adel-Ismail.CommandsMap:CommandMapsCompiler:1.0.0'
156 | }
157 |
158 | # ProGuard
159 |
160 | for ProGuard you may need to add the following rules :
161 |
162 | -dontwarn com.compiler.**
163 | -dontwarn com.annotations.**
164 | -dontwarn com.mapper.**
165 | -dontwarn com.google.auto.**
166 | -dontwarn com.google.common.**
167 | -dontwarn com.squareup.javawriter.**
168 |
--------------------------------------------------------------------------------
/.idea/codeStyleSettings.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
224 |
225 |
226 |
--------------------------------------------------------------------------------
/CommandMapsCompiler/src/main/java/com/compiler/CommandMapGenerator.java:
--------------------------------------------------------------------------------
1 | package com.compiler;
2 |
3 | import com.annotations.Command;
4 | import com.mapper.CommandsMap;
5 |
6 | import java.io.IOException;
7 | import java.io.Writer;
8 | import java.util.List;
9 |
10 | import javax.annotation.processing.ProcessingEnvironment;
11 | import javax.lang.model.element.Element;
12 | import javax.lang.model.element.ExecutableElement;
13 | import javax.lang.model.element.Name;
14 | import javax.lang.model.element.TypeElement;
15 | import javax.tools.Diagnostic;
16 | import javax.tools.JavaFileObject;
17 |
18 | import io.reactivex.Observable;
19 | import io.reactivex.annotations.NonNull;
20 | import io.reactivex.functions.Consumer;
21 | import io.reactivex.functions.Predicate;
22 |
23 | import static com.annotations.Command.NULL_DOUBLE;
24 | import static com.annotations.Command.NULL_FLOAT;
25 | import static com.annotations.Command.NULL_INTEGER;
26 | import static com.annotations.Command.NULL_LONG;
27 | import static com.annotations.Command.NULL_STRING;
28 |
29 | /**
30 | * working on the example in this link :
31 | *
36 | * public class FactoryGroupedClasses {
37 | *
38 | * Created by Ahmed Adel Ismail on 7/16/2017.
39 | */
40 |
41 | class CommandMapGenerator implements Consumer {
42 |
43 | private static final String INDENT = " ";
44 | private static final String NEW_LINE = "\n";
45 | private static final String END_LINE = ";\n";
46 | private static final String START_BLOCK = "{\n";
47 | private static final String END_BLOCK = "}\n";
48 | private static final String END_METHOD_CALL = ");\n";
49 |
50 | private final ProcessingEnvironment environment;
51 |
52 |
53 | CommandMapGenerator(ProcessingEnvironment environment) {
54 | this.environment = environment;
55 | }
56 |
57 | @Override
58 | public void accept(@NonNull TypeElement element) throws Exception {
59 | String generatedClassName = originalClassName(element) + CommandsMap.GENERATED_NAME;
60 | try {
61 | generateFile(generatedClassName, generateCode(element, generatedClassName));
62 | } catch (IOException e) {
63 | // this occurs if the file already existing after its first run, this is normal
64 | } catch (Exception e) {
65 | environment.getMessager().printMessage(Diagnostic.Kind.ERROR, e.getMessage());
66 | }
67 | }
68 |
69 | private String originalClassName(@NonNull TypeElement element) {
70 | return element.getSimpleName().toString();
71 | }
72 |
73 | private void generateFile(String generatedClassName, StringBuilder stringBuilder)
74 | throws IOException {
75 | JavaFileObject source = environment.getFiler().createSourceFile(generatedClassName);
76 | Writer writer = source.openWriter();
77 | writer.write(stringBuilder.toString());
78 | writer.flush();
79 | writer.close();
80 | }
81 |
82 | private StringBuilder generateCode(@NonNull TypeElement element, String generatedClassName) {
83 | StringBuilder stringBuilder = new StringBuilder();
84 | stringBuilder.append("package ")
85 | .append(packageName(element))
86 | .append(END_LINE)
87 | .append(NEW_LINE);
88 |
89 | stringBuilder.append("import com.mapper.*")
90 | .append(END_LINE)
91 | .append(NEW_LINE);
92 |
93 | stringBuilder.append("public final class ")
94 | .append(generatedClassName)
95 | .append(" extends CommandsMap ")
96 | .append(START_BLOCK)
97 | .append(NEW_LINE);
98 |
99 | stringBuilder
100 | .append(INDENT)
101 | .append("public ")
102 | .append(generatedClassName)
103 | .append("()")
104 | .append(START_BLOCK)
105 | .append(NEW_LINE);
106 |
107 | Observable.fromIterable(element.getEnclosedElements())
108 | .filter(byAnnotatedMethods())
109 | .blockingForEach(addCommand(stringBuilder, originalClassName(element)));
110 |
111 | stringBuilder.append(INDENT)
112 | .append(END_BLOCK)
113 | .append(END_BLOCK)
114 | .append(NEW_LINE);
115 |
116 | return stringBuilder;
117 | }
118 |
119 | private String packageName(@NonNull TypeElement element) {
120 | return environment.getElementUtils().getPackageOf(element).getQualifiedName().toString();
121 | }
122 |
123 |
124 | private Predicate byAnnotatedMethods() {
125 | return new Predicate() {
126 | @Override
127 | public boolean test(@NonNull Element element) throws Exception {
128 | return element.getAnnotation(Command.class) != null;
129 | }
130 | };
131 | }
132 |
133 | private Consumer addCommand(final StringBuilder stringBuilder,
134 | final String className) {
135 | return new Consumer() {
136 | @Override
137 | public void accept(@NonNull Element element) throws Exception {
138 |
139 | ExecutableElement method = (ExecutableElement) element;
140 | List parameters = method.getParameters();
141 |
142 | if (parameters == null || parameters.isEmpty()) {
143 | addCommandBody(element, stringBuilder, zeroParameterBody(method, className));
144 | } else {
145 | int parametersCount = parameters.size();
146 | if (parametersCount == 1) {
147 | addCommandBody(element, stringBuilder, oneParameterBody(method, className));
148 | } else if (parametersCount == 2) {
149 | addBiCommandBody(element, stringBuilder, twoParameterBody(method, className));
150 | }
151 | }
152 | }
153 | };
154 | }
155 |
156 | private void addCommandBody(@NonNull Element element,
157 | StringBuilder stringBuilder,
158 | String commandBody) {
159 |
160 | stringBuilder
161 | .append(INDENT)
162 | .append(INDENT)
163 | .append("addCommand(")
164 | .append(parseKeyFromCommandAnnotation(element))
165 | .append(", ")
166 | .append("new Command(){")
167 | .append(NEW_LINE)
168 | .append(INDENT)
169 | .append(INDENT)
170 | .append(INDENT)
171 | .append("public void accept(Object o1){")
172 | .append(NEW_LINE)
173 | .append(commandBody)
174 | .append(INDENT)
175 | .append(INDENT)
176 | .append(INDENT)
177 | .append("}")
178 | .append(NEW_LINE)
179 | .append(INDENT)
180 | .append(INDENT)
181 | .append("}")
182 | .append(END_METHOD_CALL)
183 | .append(NEW_LINE);
184 | }
185 |
186 | private String zeroParameterBody(ExecutableElement element, String className) {
187 | Name methodName = element.getSimpleName();
188 | return bodyPrefix(methodName, className) + "()" + END_LINE + bodyPostfix(methodName, className);
189 | }
190 |
191 | private String oneParameterBody(ExecutableElement element, String className) {
192 | Name methodName = element.getSimpleName();
193 | String typeCast = element.getParameters().get(0).asType().toString();
194 | return bodyPrefix(methodName, className) + "((" + typeCast + ")o1)" + END_LINE +
195 | bodyPostfix(methodName, className);
196 | }
197 |
198 | private void addBiCommandBody(Element element,
199 | StringBuilder stringBuilder,
200 | String commandBody) {
201 |
202 | stringBuilder.append(INDENT)
203 | .append(INDENT)
204 | .append("addBiCommand(")
205 | .append(parseKeyFromCommandAnnotation(element))
206 | .append(", ")
207 | .append("new BiCommand(){")
208 | .append(NEW_LINE)
209 | .append(INDENT)
210 | .append(INDENT)
211 | .append(INDENT)
212 | .append("public void accept(Object o1, Object o2){")
213 | .append(NEW_LINE)
214 | .append(commandBody)
215 | .append(INDENT)
216 | .append(INDENT)
217 | .append(INDENT)
218 | .append("}")
219 | .append(NEW_LINE)
220 | .append(INDENT)
221 | .append(INDENT)
222 | .append("}")
223 | .append(END_METHOD_CALL)
224 | .append(NEW_LINE);
225 | }
226 |
227 | private String twoParameterBody(ExecutableElement element, String className) {
228 | Name methodName = element.getSimpleName();
229 | String typeCastOne = element.getParameters().get(0).asType().toString();
230 | String typeCastTwo = element.getParameters().get(1).asType().toString();
231 | return bodyPrefix(methodName, className)
232 | + "((" + typeCastOne + ")o1, (" + typeCastTwo + ")o2)" + END_LINE +
233 | bodyPostfix(methodName, className);
234 | }
235 |
236 | private Object parseKeyFromCommandAnnotation(@NonNull Element element) {
237 |
238 | Command annotation = element.getAnnotation(Command.class);
239 |
240 | Object key = annotation.value();
241 | if (!key.equals(NULL_INTEGER)) {
242 | return key;
243 | }
244 |
245 | key = annotation.keyString();
246 | if (!key.equals(NULL_STRING)) {
247 | return "\"" + key + "\"";
248 | }
249 |
250 | key = annotation.keyLong();
251 | if (!key.equals(NULL_LONG)) {
252 | return key + "L";
253 | }
254 |
255 | key = annotation.keyDouble();
256 | if (!key.equals(NULL_DOUBLE)) {
257 | return key + "D";
258 | }
259 |
260 | key = annotation.keyFloat();
261 | if (!key.equals(NULL_FLOAT)) {
262 | return key + "F";
263 | }
264 |
265 | throw new IllegalArgumentException("@" + Command.class.getSimpleName()
266 | + " must have a value in : " + element.getSimpleName() + "()");
267 | }
268 |
269 | private String bodyPrefix(Name methodName, String className) {
270 | return INDENT + INDENT + INDENT + INDENT +
271 | "if(getHostObject() != null){"
272 | + NEW_LINE
273 | + INDENT + INDENT + INDENT + INDENT + INDENT
274 | + "((" + className + ")getHostObject())." + methodName;
275 | }
276 |
277 | private String bodyPostfix(Name methodName, String className) {
278 | return INDENT + INDENT + INDENT + INDENT +
279 | "} else { "
280 | + NEW_LINE
281 | + INDENT + INDENT + INDENT + INDENT + INDENT
282 | + "java.lang.System.out.println(\" " + CommandsMap.class.getSimpleName() + " cleared for "
283 | + className + "." + methodName + "() \"); "
284 | + NEW_LINE
285 | + INDENT + INDENT + INDENT + INDENT
286 | + "}"
287 | + NEW_LINE;
288 | }
289 |
290 |
291 | }
292 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "{}"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright {yyyy} {name of copyright owner}
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------