Hi Team, Currently I'm working on the Flink Table Maintenance see: https://github.com/apache/iceberg/pull/11144#discussion_r1764015878, and with Steven we are trying to find a good way to organize the incoming 50 classes.
There will be: - ~10 classes which will be used by the users - ~10 classes which are needed for the infrastructure (scheduling, locking, etc) - The rest of the classes are distributed between the 4 planned maintenance tasks, and some of them are reused between them The tools we have: - Java access modifiers - Java packages - Flink annotations (Public/Internal) - Anything else? The possibilities we considered - Keep everything in a single package, use package private for anything which is not supposed to be used by the user, and use public modifiers only on the public API - my issue with this solution that having 50 classes in a package is too much. - Start organizing the classes into sub-packages. This requires us to set public modifiers on classes/methods used in other packages. We can still leverage the Flink annotations to separate public and internal classes/methods - my issue with this solution is that it requires considerable mental effort to remember/check what is public and what is not. - Create an 'api' package which contains only the classes used by the clients, and put everything internal to different packages. We still can/should use the annotations to mark the other classes internal, but IMHO this helps understanding the code a lot. WDYT? Any other suggestions? Maybe even something which is already used in the Iceberg codebase? Thanks, Peter
