From 25ae6a94a0a86a8fd003e6f1263c117bf705c36d Mon Sep 17 00:00:00 2001 From: Edouard DUPIN Date: Tue, 3 May 2022 23:32:40 +0200 Subject: [PATCH] [DEV] basis of aknot --- .checkstyle | 7 + .classpath | 26 + .gitignore | 22 + .project | 35 ++ CheckStyle.xml | 66 ++ CleanUp.xml | 106 ++++ Formatter.xml | 390 ++++++++++++ LICENSE | 373 +++++++++++ src/module-info.java | 16 + .../aknot/annotation/AknotAnnotation.java | 19 + .../aknot/annotation/AknotAttribute.java | 20 + .../aknot/annotation/AknotCaseSensitive.java | 21 + .../annotation/AknotDefaultAttribute.java | 20 + .../annotation/AknotDefaultCaseSensitive.java | 20 + .../aknot/annotation/AknotDefaultManaged.java | 21 + .../annotation/AknotDefaultNullValue.java | 18 + .../annotation/AknotDefaultOptional.java | 21 + .../aknot/annotation/AknotDescription.java | 13 + .../aknot/annotation/AknotFactory.java | 21 + .../aknot/annotation/AknotIgnoreUnknown.java | 20 + .../atriasoft/aknot/annotation/AknotList.java | 29 + .../aknot/annotation/AknotManaged.java | 21 + .../atriasoft/aknot/annotation/AknotName.java | 24 + .../aknot/annotation/AknotOptional.java | 21 + .../aknot/annotation/AknotSignal.java | 13 + .../atriasoft/aknot/annotation/AknotText.java | 20 + .../aknot/exception/AknotException.java | 18 + src/org/atriasoft/aknot/internal/Log.java | 81 +++ .../aknot/model/InterfaceFactoryAccess.java | 22 + .../atriasoft/aknot/reflect/ReflectClass.java | 166 +++++ .../atriasoft/aknot/reflect/ReflectTools.java | 583 ++++++++++++++++++ .../test/atriasoft/aknot/ExmlTestElement.java | 35 ++ version.txt | 1 + 33 files changed, 2289 insertions(+) create mode 100644 .checkstyle create mode 100644 .classpath create mode 100644 .gitignore create mode 100644 .project create mode 100755 CheckStyle.xml create mode 100644 CleanUp.xml create mode 100644 Formatter.xml create mode 100644 LICENSE create mode 100644 src/module-info.java create mode 100644 src/org/atriasoft/aknot/annotation/AknotAnnotation.java create mode 100644 src/org/atriasoft/aknot/annotation/AknotAttribute.java create mode 100644 src/org/atriasoft/aknot/annotation/AknotCaseSensitive.java create mode 100644 src/org/atriasoft/aknot/annotation/AknotDefaultAttribute.java create mode 100644 src/org/atriasoft/aknot/annotation/AknotDefaultCaseSensitive.java create mode 100644 src/org/atriasoft/aknot/annotation/AknotDefaultManaged.java create mode 100644 src/org/atriasoft/aknot/annotation/AknotDefaultNullValue.java create mode 100644 src/org/atriasoft/aknot/annotation/AknotDefaultOptional.java create mode 100644 src/org/atriasoft/aknot/annotation/AknotDescription.java create mode 100644 src/org/atriasoft/aknot/annotation/AknotFactory.java create mode 100644 src/org/atriasoft/aknot/annotation/AknotIgnoreUnknown.java create mode 100644 src/org/atriasoft/aknot/annotation/AknotList.java create mode 100644 src/org/atriasoft/aknot/annotation/AknotManaged.java create mode 100644 src/org/atriasoft/aknot/annotation/AknotName.java create mode 100644 src/org/atriasoft/aknot/annotation/AknotOptional.java create mode 100644 src/org/atriasoft/aknot/annotation/AknotSignal.java create mode 100644 src/org/atriasoft/aknot/annotation/AknotText.java create mode 100644 src/org/atriasoft/aknot/exception/AknotException.java create mode 100644 src/org/atriasoft/aknot/internal/Log.java create mode 100644 src/org/atriasoft/aknot/model/InterfaceFactoryAccess.java create mode 100644 src/org/atriasoft/aknot/reflect/ReflectClass.java create mode 100644 src/org/atriasoft/aknot/reflect/ReflectTools.java create mode 100644 test/src/test/atriasoft/aknot/ExmlTestElement.java create mode 100644 version.txt diff --git a/.checkstyle b/.checkstyle new file mode 100644 index 0000000..428926e --- /dev/null +++ b/.checkstyle @@ -0,0 +1,7 @@ + + + + + + + diff --git a/.classpath b/.classpath new file mode 100644 index 0000000..57811b1 --- /dev/null +++ b/.classpath @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..fdd52d6 --- /dev/null +++ b/.gitignore @@ -0,0 +1,22 @@ + +/__pycache__/ +/bin/ +/Operator/ +/DrawerProperties/ +*.pdfd +*.dbc +SchedulerConfig.txt +scenicView.properties +ScenariumConfig.txt +*.class +*~ +*.bck +build.number +/extern/ +/out/ +/.settings/ +/junit/ +/target/ + +/*.log + diff --git a/.project b/.project new file mode 100644 index 0000000..bfa2f2a --- /dev/null +++ b/.project @@ -0,0 +1,35 @@ + + + atriasoft-aknot + + + atriasoft-aknot + + + + org.eclipse.jdt.core.javabuilder + + + + + net.sf.eclipsecs.core.CheckstyleBuilder + + + + + + org.eclipse.jdt.core.javanature + net.sf.eclipsecs.core.CheckstyleNature + + + + 1646149232194 + + 30 + + org.eclipse.core.resources.regexFilterMatcher + node_modules|.git|__CREATED_BY_JAVA_LANGUAGE_SERVER__ + + + + diff --git a/CheckStyle.xml b/CheckStyle.xml new file mode 100755 index 0000000..d68aedd --- /dev/null +++ b/CheckStyle.xml @@ -0,0 +1,66 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/CleanUp.xml b/CleanUp.xml new file mode 100644 index 0000000..6cf4cba --- /dev/null +++ b/CleanUp.xml @@ -0,0 +1,106 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Formatter.xml b/Formatter.xml new file mode 100644 index 0000000..14a5d6c --- /dev/null +++ b/Formatter.xml @@ -0,0 +1,390 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a612ad9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/src/module-info.java b/src/module-info.java new file mode 100644 index 0000000..4a91a3c --- /dev/null +++ b/src/module-info.java @@ -0,0 +1,16 @@ +/** @file + * @author Edouard DUPIN + * @copyright 2021, Edouard DUPIN, all right reserved + * @license MPL v2.0 (see license file) + */ + +open module org.atriasoft.aknot { + exports org.atriasoft.aknot.reflect; + exports org.atriasoft.aknot.annotation; + exports org.atriasoft.aknot.model; + exports org.atriasoft.aknot.exception; + + requires transitive org.atriasoft.etk; + requires transitive io.scenarium.logger; + requires java.base; +} diff --git a/src/org/atriasoft/aknot/annotation/AknotAnnotation.java b/src/org/atriasoft/aknot/annotation/AknotAnnotation.java new file mode 100644 index 0000000..1d27b3f --- /dev/null +++ b/src/org/atriasoft/aknot/annotation/AknotAnnotation.java @@ -0,0 +1,19 @@ +package org.atriasoft.aknot.annotation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Meta-annotation (annotations used on other annotations) + * used for marking all annotations that are + * part of Exml package. Can be used for recognizing all + * Exml annotations generically, and in future also for + * passing other generic annotation configuration. + */ +@Target(ElementType.ANNOTATION_TYPE) +@Retention(RetentionPolicy.RUNTIME) +public @interface AknotAnnotation { + // for now, a pure tag annotation, no parameters +} \ No newline at end of file diff --git a/src/org/atriasoft/aknot/annotation/AknotAttribute.java b/src/org/atriasoft/aknot/annotation/AknotAttribute.java new file mode 100644 index 0000000..968c1b8 --- /dev/null +++ b/src/org/atriasoft/aknot/annotation/AknotAttribute.java @@ -0,0 +1,20 @@ +package org.atriasoft.aknot.annotation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Marker annotation that set the Xml element seen as a property. + */ +@Target({ ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER }) +@Retention(RetentionPolicy.RUNTIME) +@AknotAnnotation +public @interface AknotAttribute { + /** + * Set at true to set the element managed as a property of the Xml node + * @return property management. + */ + boolean value() default true; +} \ No newline at end of file diff --git a/src/org/atriasoft/aknot/annotation/AknotCaseSensitive.java b/src/org/atriasoft/aknot/annotation/AknotCaseSensitive.java new file mode 100644 index 0000000..1ac029e --- /dev/null +++ b/src/org/atriasoft/aknot/annotation/AknotCaseSensitive.java @@ -0,0 +1,21 @@ +package org.atriasoft.aknot.annotation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Marker annotation that to set the element is case sensitive or not. + * + */ +@Target({ ElementType.FIELD, ElementType.TYPE, ElementType.METHOD, ElementType.PARAMETER }) +@Retention(RetentionPolicy.RUNTIME) +@AknotAnnotation +public @interface AknotCaseSensitive { + /** + * Set if the element is is case sensitive. + * @return true if case sensitive + */ + boolean value() default true; +} \ No newline at end of file diff --git a/src/org/atriasoft/aknot/annotation/AknotDefaultAttribute.java b/src/org/atriasoft/aknot/annotation/AknotDefaultAttribute.java new file mode 100644 index 0000000..723e0c3 --- /dev/null +++ b/src/org/atriasoft/aknot/annotation/AknotDefaultAttribute.java @@ -0,0 +1,20 @@ +package org.atriasoft.aknot.annotation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Marker annotation that permit to set the default parsing as attributes. + */ +@Target(ElementType.TYPE) +@Retention(RetentionPolicy.RUNTIME) +@AknotAnnotation +public @interface AknotDefaultAttribute { + /** + * Set this to false to select the attribute as default. + * @return true select default attribute, false select default element. + */ + boolean value() default true; +} \ No newline at end of file diff --git a/src/org/atriasoft/aknot/annotation/AknotDefaultCaseSensitive.java b/src/org/atriasoft/aknot/annotation/AknotDefaultCaseSensitive.java new file mode 100644 index 0000000..3ef1b40 --- /dev/null +++ b/src/org/atriasoft/aknot/annotation/AknotDefaultCaseSensitive.java @@ -0,0 +1,20 @@ +package org.atriasoft.aknot.annotation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Marker annotation that permit to select if the parsing is case sensitive or not. + */ +@Target(ElementType.TYPE) +@Retention(RetentionPolicy.RUNTIME) +@AknotAnnotation +public @interface AknotDefaultCaseSensitive { + /** + * Set this at true to set all the element are case sensitive. + * @return true if the element are by default case_sensitive. + */ + boolean value() default true; +} \ No newline at end of file diff --git a/src/org/atriasoft/aknot/annotation/AknotDefaultManaged.java b/src/org/atriasoft/aknot/annotation/AknotDefaultManaged.java new file mode 100644 index 0000000..4feee65 --- /dev/null +++ b/src/org/atriasoft/aknot/annotation/AknotDefaultManaged.java @@ -0,0 +1,21 @@ +package org.atriasoft.aknot.annotation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Marker annotation that set the element are not managed by default. Need to add @Managed to be enable. + * + */ +@Target(ElementType.TYPE) +@Retention(RetentionPolicy.RUNTIME) +@AknotAnnotation +public @interface AknotDefaultManaged { + /** + * Set this at false to remove all the field and the function from Xml introspection + * @return true if the element are by default managed. + */ + boolean value() default true; +} \ No newline at end of file diff --git a/src/org/atriasoft/aknot/annotation/AknotDefaultNullValue.java b/src/org/atriasoft/aknot/annotation/AknotDefaultNullValue.java new file mode 100644 index 0000000..6a77d3b --- /dev/null +++ b/src/org/atriasoft/aknot/annotation/AknotDefaultNullValue.java @@ -0,0 +1,18 @@ +package org.atriasoft.aknot.annotation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +@Target(ElementType.TYPE) +@Retention(RetentionPolicy.RUNTIME) +@AknotAnnotation +public @interface AknotDefaultNullValue { + /** + * Set the default value at true in the constructor if needed (set at 0 for basic type int, long ...). + * @return true if the element are by default at null. + */ + boolean value() default true; + +} diff --git a/src/org/atriasoft/aknot/annotation/AknotDefaultOptional.java b/src/org/atriasoft/aknot/annotation/AknotDefaultOptional.java new file mode 100644 index 0000000..1992d69 --- /dev/null +++ b/src/org/atriasoft/aknot/annotation/AknotDefaultOptional.java @@ -0,0 +1,21 @@ +package org.atriasoft.aknot.annotation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Marker annotation that set the element not found are ignored. + * + */ +@Target(ElementType.TYPE) +@Retention(RetentionPolicy.RUNTIME) +@AknotAnnotation +public @interface AknotDefaultOptional { + /** + * Set this at true to set all the element optional. + * @return true if the element are by default optional. + */ + boolean value() default false; +} \ No newline at end of file diff --git a/src/org/atriasoft/aknot/annotation/AknotDescription.java b/src/org/atriasoft/aknot/annotation/AknotDescription.java new file mode 100644 index 0000000..ab70b28 --- /dev/null +++ b/src/org/atriasoft/aknot/annotation/AknotDescription.java @@ -0,0 +1,13 @@ +package org.atriasoft.aknot.annotation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +@Target({ ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE }) +@Retention(RetentionPolicy.RUNTIME) +@AknotAnnotation +public @interface AknotDescription { + String value(); +} diff --git a/src/org/atriasoft/aknot/annotation/AknotFactory.java b/src/org/atriasoft/aknot/annotation/AknotFactory.java new file mode 100644 index 0000000..d65f73e --- /dev/null +++ b/src/org/atriasoft/aknot/annotation/AknotFactory.java @@ -0,0 +1,21 @@ +package org.atriasoft.aknot.annotation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Marker annotation that permit to set the default parsing as attributes. + */ +@Target(ElementType.METHOD) +@Retention(RetentionPolicy.RUNTIME) +@AknotAnnotation +public @interface AknotFactory { + /** + * Set this to false to select the attribute as default. + * @return true select default attribute, false select default element. + */ + Class value(); + +} diff --git a/src/org/atriasoft/aknot/annotation/AknotIgnoreUnknown.java b/src/org/atriasoft/aknot/annotation/AknotIgnoreUnknown.java new file mode 100644 index 0000000..c73bad3 --- /dev/null +++ b/src/org/atriasoft/aknot/annotation/AknotIgnoreUnknown.java @@ -0,0 +1,20 @@ +package org.atriasoft.aknot.annotation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Marker annotation that permit to set the default parsing as attributes. + */ +@Target(ElementType.TYPE) +@Retention(RetentionPolicy.RUNTIME) +@AknotAnnotation +public @interface AknotIgnoreUnknown { + /** + * Set the element ignore unknown Nodes. + * @return true does not display unknown node. + */ + boolean value() default true; +} \ No newline at end of file diff --git a/src/org/atriasoft/aknot/annotation/AknotList.java b/src/org/atriasoft/aknot/annotation/AknotList.java new file mode 100644 index 0000000..6409051 --- /dev/null +++ b/src/org/atriasoft/aknot/annotation/AknotList.java @@ -0,0 +1,29 @@ +package org.atriasoft.aknot.annotation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Marker annotation that can be used to define a group list of element: + * {@code + * + * ... + * ... + * ... + * + * } + * @apiNote To change the group name @see XmlName + */ +@Target({ ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER }) +@Retention(RetentionPolicy.RUNTIME) +@AknotAnnotation +public @interface AknotList { + + /** + * Element names node + * @return The name of the elements + */ + String value(); +} \ No newline at end of file diff --git a/src/org/atriasoft/aknot/annotation/AknotManaged.java b/src/org/atriasoft/aknot/annotation/AknotManaged.java new file mode 100644 index 0000000..3f1c174 --- /dev/null +++ b/src/org/atriasoft/aknot/annotation/AknotManaged.java @@ -0,0 +1,21 @@ +package org.atriasoft.aknot.annotation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Marker annotation that force the xml Parser to manage this element (used when the class is mark as @XmldefaultNotManaged). + * + */ +@Target({ ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER}) +@Retention(RetentionPolicy.RUNTIME) +@AknotAnnotation +public @interface AknotManaged { + /** + * Set this at false to remove this function or this field form the XML parsing system + * @return true if the element is managed. + */ + boolean value() default true; +} \ No newline at end of file diff --git a/src/org/atriasoft/aknot/annotation/AknotName.java b/src/org/atriasoft/aknot/annotation/AknotName.java new file mode 100644 index 0000000..90d574f --- /dev/null +++ b/src/org/atriasoft/aknot/annotation/AknotName.java @@ -0,0 +1,24 @@ +package org.atriasoft.aknot.annotation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Marker annotation that can be used to define an other name of the attribute or the Element name. + * + */ +@Target({ ElementType.FIELD, ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.PARAMETER }) +@Retention(RetentionPolicy.RUNTIME) +@AknotAnnotation +public @interface AknotName { + + /** + * Names of the property of the Element name + * @note The first name if the default generated in serialization. + * @return The list the the possible names + * @apiNote this is incompatible with XmlModel + */ + String[] value(); +} \ No newline at end of file diff --git a/src/org/atriasoft/aknot/annotation/AknotOptional.java b/src/org/atriasoft/aknot/annotation/AknotOptional.java new file mode 100644 index 0000000..97909d7 --- /dev/null +++ b/src/org/atriasoft/aknot/annotation/AknotOptional.java @@ -0,0 +1,21 @@ +package org.atriasoft.aknot.annotation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Marker annotation that to ignore the element if not present in the XML, the default case the parser throw a missing error. + * + */ +@Target({ ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER }) +@Retention(RetentionPolicy.RUNTIME) +@AknotAnnotation +public @interface AknotOptional { + /** + * Set if the element is optional or not. If optional, the parser does not throw error if the element is not declared. + * @return thru if optional + */ + boolean value() default true; +} \ No newline at end of file diff --git a/src/org/atriasoft/aknot/annotation/AknotSignal.java b/src/org/atriasoft/aknot/annotation/AknotSignal.java new file mode 100644 index 0000000..0d8b1d3 --- /dev/null +++ b/src/org/atriasoft/aknot/annotation/AknotSignal.java @@ -0,0 +1,13 @@ +package org.atriasoft.aknot.annotation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +@Target(ElementType.FIELD) +@Retention(RetentionPolicy.RUNTIME) +@AknotAnnotation +public @interface AknotSignal { + boolean value() default true; +} diff --git a/src/org/atriasoft/aknot/annotation/AknotText.java b/src/org/atriasoft/aknot/annotation/AknotText.java new file mode 100644 index 0000000..5ea097d --- /dev/null +++ b/src/org/atriasoft/aknot/annotation/AknotText.java @@ -0,0 +1,20 @@ +package org.atriasoft.aknot.annotation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Marker annotation that set the Xml element seen as a property. + */ +@Target({ ElementType.FIELD, ElementType.METHOD }) +@Retention(RetentionPolicy.RUNTIME) +@AknotAnnotation +public @interface AknotText { + /** + * Set at true to set the element used as text data as a property of the Xml node + * @return property management. + */ + boolean value() default true; +} \ No newline at end of file diff --git a/src/org/atriasoft/aknot/exception/AknotException.java b/src/org/atriasoft/aknot/exception/AknotException.java new file mode 100644 index 0000000..e6dedea --- /dev/null +++ b/src/org/atriasoft/aknot/exception/AknotException.java @@ -0,0 +1,18 @@ +/** @file + * @author Edouard DUPIN + * @copyright 2021, Edouard DUPIN, all right reserved + * @license MPL v2.0 (see license file) + */ +package org.atriasoft.aknot.exception; + +public class AknotException extends Exception { + /** + * Generate Unique ID for serialization + */ + private static final long serialVersionUID = 1L; + + public AknotException(final String data) { + super(data); + } + +} diff --git a/src/org/atriasoft/aknot/internal/Log.java b/src/org/atriasoft/aknot/internal/Log.java new file mode 100644 index 0000000..425f87c --- /dev/null +++ b/src/org/atriasoft/aknot/internal/Log.java @@ -0,0 +1,81 @@ +/** @file + * @author Edouard DUPIN + * @copyright 2021, Edouard DUPIN, all right reserved + * @license MPL v2.0 (see license file) + */ +package org.atriasoft.aknot.internal; + +import io.scenarium.logger.LogLevel; +import io.scenarium.logger.Logger; + +public class Log { + private static final boolean FORCE_ALL = false; + private static final String LIB_NAME = "exml"; + private static final String LIB_NAME_DRAW = Logger.getDrawableName(Log.LIB_NAME); + private static final boolean PRINT_CRITICAL = Logger.getNeedPrint(Log.LIB_NAME, LogLevel.CRITICAL); + private static final boolean PRINT_DEBUG = Logger.getNeedPrint(Log.LIB_NAME, LogLevel.DEBUG); + private static final boolean PRINT_ERROR = Logger.getNeedPrint(Log.LIB_NAME, LogLevel.ERROR); + private static final boolean PRINT_INFO = Logger.getNeedPrint(Log.LIB_NAME, LogLevel.INFO); + private static final boolean PRINT_PRINT = Logger.getNeedPrint(Log.LIB_NAME, LogLevel.PRINT); + private static final boolean PRINT_TODO = Logger.getNeedPrint(Log.LIB_NAME, LogLevel.TODO); + private static final boolean PRINT_VERBOSE = Logger.getNeedPrint(Log.LIB_NAME, LogLevel.VERBOSE); + private static final boolean PRINT_WARNING = Logger.getNeedPrint(Log.LIB_NAME, LogLevel.WARNING); + + public static void critical(final Exception e, final String data) { + e.printStackTrace(); + if (PRINT_CRITICAL || FORCE_ALL) { + Logger.critical(LIB_NAME_DRAW, data + " : " + e.getMessage()); + } + } + + public static void critical(final String data, final Object... objects) { + if (PRINT_CRITICAL || FORCE_ALL) { + Logger.critical(LIB_NAME_DRAW, data, objects); + } + } + + public static void debug(final String data, final Object... objects) { + if (PRINT_DEBUG || FORCE_ALL) { + Logger.debug(LIB_NAME_DRAW, data, objects); + } + } + + public static void error(final String data, final Object... objects) { + if (PRINT_ERROR || FORCE_ALL) { + Logger.error(LIB_NAME_DRAW, data, objects); + } + } + + public static void info(final String data, final Object... objects) { + if (PRINT_INFO || FORCE_ALL) { + Logger.info(LIB_NAME_DRAW, data, objects); + } + } + + public static void print(final String data, final Object... objects) { + if (PRINT_PRINT || FORCE_ALL) { + Logger.print(LIB_NAME_DRAW, data, objects); + } + } + + public static void todo(final String data, final Object... objects) { + if (PRINT_TODO || FORCE_ALL) { + Logger.todo(LIB_NAME_DRAW, data, objects); + } + } + + public static void verbose(final String data, final Object... objects) { + if (PRINT_VERBOSE || FORCE_ALL) { + Logger.verbose(LIB_NAME_DRAW, data, objects); + } + } + + public static void warning(final String data, final Object... objects) { + if (PRINT_WARNING || FORCE_ALL) { + Logger.warning(LIB_NAME_DRAW, data, objects); + } + } + + private Log() {} + +} diff --git a/src/org/atriasoft/aknot/model/InterfaceFactoryAccess.java b/src/org/atriasoft/aknot/model/InterfaceFactoryAccess.java new file mode 100644 index 0000000..d147401 --- /dev/null +++ b/src/org/atriasoft/aknot/model/InterfaceFactoryAccess.java @@ -0,0 +1,22 @@ +package org.atriasoft.aknot.model; + +import java.util.Map; + +public interface InterfaceFactoryAccess { + /** + * Find the class type with the specific name. + * @param name Name of the node to find. + * @param caseSensitive Check if the name with case sensitive mode. + * @return Value of the class interface to create or null. + */ + Class findClass(String name, boolean caseSensitive); + + /** + * Retrieve the name of the node in xml for the specific Object. + * @param object The object that we need to find the type name. + * @return The xml string to inject (or null). + */ + String generateName(Object object); + + Map> getConversionMap(); +} \ No newline at end of file diff --git a/src/org/atriasoft/aknot/reflect/ReflectClass.java b/src/org/atriasoft/aknot/reflect/ReflectClass.java new file mode 100644 index 0000000..95f60fa --- /dev/null +++ b/src/org/atriasoft/aknot/reflect/ReflectClass.java @@ -0,0 +1,166 @@ +package org.atriasoft.aknot.reflect; + +import java.lang.reflect.Method; +import java.lang.reflect.Modifier; +import java.util.ArrayList; +import java.util.List; +import java.util.stream.Collectors; + +public class ReflectClass { + // Separate the methods and filer as: + // - XXX GetXxx(); & XXX != boolean + // - void setXxx(XXX elem); + // - [bB]oolean isXxx(); + // for records: + // - xxx(); + public static List extractGetMethod(final Class classType, final List methods, final List recordAllPossibleValues) { + final boolean isRecord = Record.class.isAssignableFrom(classType); + if (!Enum.class.isAssignableFrom(classType)) { + if (isRecord && recordAllPossibleValues != null) { + return methods.stream().filter(o -> recordAllPossibleValues.contains(o.getName())).collect(Collectors.toList()); + } else { + return methods.stream().filter(o -> o.getName().startsWith("get")).collect(Collectors.toList()); + } + } + return new ArrayList<>(); + } + + public static List extractIsMethod(final Class classType, final List methods) { + final boolean isRecord = Record.class.isAssignableFrom(classType); + if (!Enum.class.isAssignableFrom(classType)) { + if (isRecord) { + return new ArrayList<>(); + } else { + return methods.stream().filter(o -> o.getName().startsWith("is")).collect(Collectors.toList()); + } + } + return new ArrayList<>(); + } + + public static List extractSetMethod(final Class classType, final List methods) { + final boolean isRecord = Record.class.isAssignableFrom(classType); + if (!Enum.class.isAssignableFrom(classType)) { + if (isRecord) { + return new ArrayList<>(); + } else { + return methods.stream().filter(o -> o.getName().startsWith("set")).collect(Collectors.toList()); + } + } + return new ArrayList<>(); + } + + public static Method extractToString(final List methods) { + final List tostringMethod = methods.stream().filter(o -> o.getName().equals("toString")).collect(Collectors.toList()); + if (tostringMethod.size() == 1) { + return tostringMethod.get(0); + } + // some specific model: + return null; + } + + public static Method extractValueOf(final List methods) { + final List valueOfString = methods.stream().filter(o -> o.getName().equals("valueOf")).collect(Collectors.toList()); + if (valueOfString.size() == 1) { + return valueOfString.get(0); + } + // some specific model: + return null; + } + + public static List getFilterGenericFucntion(final Class classType, final List recordAllPossibleValues, final boolean keepGet, final boolean keepSet, + final boolean keepStringSerialisation) { + final Method[] methodsTmp = classType.getMethods(); + final List recordAllPossibleValuesFiltered = new ArrayList<>(); + final boolean isRecord = Record.class.isAssignableFrom(classType); + // filter getX setX isX + final List methods = List.of(methodsTmp).stream().filter(o -> { + if (o.getName().contentEquals("getClass")) { + return false; + } + // we does not manage private function + if (!Modifier.isPublic(o.getModifiers())) { + return false; + } + if (Modifier.isStatic(o.getModifiers())) { + if (!keepStringSerialisation) { + return false; + } + if (o.getName().contentEquals("valueOf") && o.getParameterCount() == 1 && o.getParameters()[0].getType() == String.class) { + return true; + } + return false; + } + if (o.getName().equals("toString")) { + if (!keepStringSerialisation) { + return false; + } + if (o.getParameterCount() != 0 || o.getReturnType() != String.class) { + return false; + } + return true; + } + if (isRecord && recordAllPossibleValues != null) { + if (recordAllPossibleValues.contains(o.getName())) { + // This list is the real list of record members + recordAllPossibleValuesFiltered.add(o.getName()); + return true; + } + } else { + if (o.getName().startsWith("get")) { + if (!keepGet) { + return false; + } + if (o.getParameterCount() != 0 || o.getReturnType() == void.class || o.getReturnType() == Boolean.class || o.getReturnType() == boolean.class) { + return false; + } + // check name format + if (o.getName().length() == 3) { + return false; + } + if (o.getName().charAt(3) >= 'A' && o.getName().charAt(3) <= 'Z') { + return true; + } + return false; + } + if (o.getName().startsWith("set")) { + if (!keepSet) { + return false; + } + if (o.getReturnType() != void.class || o.getParameterCount() != 1) { + return false; + } + // check name format + if (o.getName().length() == 3) { + return false; + } + if (o.getName().charAt(3) >= 'A' && o.getName().charAt(3) <= 'Z') { + return true; + } + return false; + } + if (o.getName().startsWith("is")) { + if (!keepGet) { + return false; + } + if ((o.getReturnType() != Boolean.class && o.getReturnType() != boolean.class) || o.getParameterCount() != 0) { + return false; + } + // check name format + if (o.getName().length() == 2) { + return false; + } + if (o.getName().charAt(2) >= 'A' && o.getName().charAt(2) <= 'Z') { + return true; + } + return false; + } + } + return false; + }).collect(Collectors.toList()); + return methods; + } + + private ReflectClass() { + + } +} diff --git a/src/org/atriasoft/aknot/reflect/ReflectTools.java b/src/org/atriasoft/aknot/reflect/ReflectTools.java new file mode 100644 index 0000000..084782c --- /dev/null +++ b/src/org/atriasoft/aknot/reflect/ReflectTools.java @@ -0,0 +1,583 @@ +package org.atriasoft.aknot.reflect; + +import java.lang.annotation.Annotation; +import java.lang.reflect.Constructor; +import java.lang.reflect.Field; +import java.lang.reflect.Method; +import java.lang.reflect.Parameter; +import java.lang.reflect.ParameterizedType; +import java.lang.reflect.Type; +import java.util.List; + +import org.atriasoft.aknot.annotation.AknotAttribute; +import org.atriasoft.aknot.annotation.AknotCaseSensitive; +import org.atriasoft.aknot.annotation.AknotDefaultAttribute; +import org.atriasoft.aknot.annotation.AknotDefaultCaseSensitive; +import org.atriasoft.aknot.annotation.AknotDefaultManaged; +import org.atriasoft.aknot.annotation.AknotDefaultNullValue; +import org.atriasoft.aknot.annotation.AknotDefaultOptional; +import org.atriasoft.aknot.annotation.AknotDescription; +import org.atriasoft.aknot.annotation.AknotFactory; +import org.atriasoft.aknot.annotation.AknotIgnoreUnknown; +import org.atriasoft.aknot.annotation.AknotList; +import org.atriasoft.aknot.annotation.AknotManaged; +import org.atriasoft.aknot.annotation.AknotName; +import org.atriasoft.aknot.annotation.AknotOptional; +import org.atriasoft.aknot.annotation.AknotSignal; +import org.atriasoft.aknot.annotation.AknotText; +import org.atriasoft.aknot.exception.AknotException; +import org.atriasoft.aknot.internal.Log; + +public class ReflectTools { + public static String getDescription(final Class element) throws Exception { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotDescription.class); + if (annotation.length == 0) { + return ""; + } + if (annotation.length > 1) { + throw new Exception("Must not have more than 1 element @AknotDescription on " + element.getClass().getCanonicalName()); + } + final String tmp = ((AknotDescription) annotation[0]).value(); + if (tmp == null) { + return "null"; + } + return tmp; + } + + public static String getDescription(final Constructor element) throws Exception { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotDescription.class); + if (annotation.length == 0) { + return ""; + } + if (annotation.length > 1) { + throw new Exception("Must not have more than 1 element @AknotDescription on " + element.getClass().getCanonicalName()); + } + final String tmp = ((AknotDescription) annotation[0]).value(); + if (tmp == null) { + return "null"; + } + return tmp; + } + + public static String getDescription(final Field element) throws Exception { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotDescription.class); + if (annotation.length == 0) { + return ""; + } + if (annotation.length > 1) { + throw new Exception("Must not have more than 1 element @AknotDescription on " + element.getClass().getCanonicalName()); + } + final String tmp = ((AknotDescription) annotation[0]).value(); + if (tmp == null) { + return "null"; + } + return tmp; + } + + public static String getDescription(final Method element) throws Exception { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotDescription.class); + if (annotation.length == 0) { + return ""; + } + if (annotation.length > 1) { + throw new Exception("Must not have more than 1 element @AknotDescription on " + element.getClass().getCanonicalName()); + } + final String tmp = ((AknotDescription) annotation[0]).value(); + if (tmp == null) { + return "null"; + } + return tmp; + } + + public static Class getFactory(final Field element) throws AknotException { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotFactory.class); + if (annotation.length == 0) { + return null; + } + if (annotation.length > 1) { + throw new AknotException("Must not have more than 1 element @AknotFactory on " + element.getClass().getCanonicalName()); + } + return ((AknotFactory) annotation[0]).value(); + } + + public static Class getFactory(final Method element) throws AknotException { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotFactory.class); + if (annotation.length == 0) { + return null; + } + if (annotation.length > 1) { + throw new AknotException("Must not have more than 1 element @AknotFactory on " + element.getClass().getCanonicalName()); + } + return ((AknotFactory) annotation[0]).value(); + } + + public static Boolean getIsAttribute(final Constructor constructor, final Parameter element, final Boolean parentValue) throws AknotException { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotAttribute.class); + if (annotation.length == 0) { + return parentValue; + } + if (annotation.length > 1) { + throw new AknotException("Must not have more than 1 element @AknotAttribute on " + constructor.getClass().getCanonicalName()); + } + return ((AknotAttribute) annotation[0]).value(); + } + + public static Boolean getIsAttribute(final Field element, final Boolean parentValue) throws AknotException { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotAttribute.class); + if (annotation.length == 0) { + return parentValue; + } + if (annotation.length > 1) { + throw new AknotException("Must not have more than 1 element @AknotAttribute on " + element.getClass().getCanonicalName()); + } + return ((AknotAttribute) annotation[0]).value(); + } + + public static Boolean getIsAttribute(final Method element, final Boolean parentValue) throws AknotException { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotAttribute.class); + if (annotation.length == 0) { + return parentValue; + } + if (annotation.length > 1) { + throw new AknotException("Must not have more than 1 element @AknotAttribute on " + element.getClass().getCanonicalName()); + } + return ((AknotAttribute) annotation[0]).value(); + } + + public static Boolean getIsCaseSensitive(final Constructor constructor, final Parameter element, final Boolean parentValue) throws AknotException { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotCaseSensitive.class); + if (annotation.length == 0) { + return parentValue; + } + if (annotation.length > 1) { + throw new AknotException("Must not have more than 1 element @AknotCaseSensitive on " + constructor.getClass().getCanonicalName()); + } + return ((AknotCaseSensitive) annotation[0]).value(); + } + + public static Boolean getIsCaseSensitive(final Field element, final Boolean defaultValue) throws AknotException { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotCaseSensitive.class); + if (annotation.length == 0) { + return defaultValue; + } + if (annotation.length > 1) { + throw new AknotException("Must not have more than 1 element @AknotCaseSensitive on " + element.getClass().getCanonicalName()); + } + return ((AknotCaseSensitive) annotation[0]).value(); + } + + public static Boolean getIsCaseSensitive(final Method element, final Boolean defaultValue) throws AknotException { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotCaseSensitive.class); + if (annotation.length == 0) { + return defaultValue; + } + if (annotation.length > 1) { + throw new AknotException("Must not have more than 1 element @AknotCaseSensitive on " + element.getClass().getCanonicalName()); + } + return ((AknotCaseSensitive) annotation[0]).value(); + } + + public static Boolean getIsDefaultAttribute(final Class classType, final Boolean defaultValue) throws AknotException { + final Annotation[] annotation = classType.getDeclaredAnnotationsByType(AknotDefaultAttribute.class); + if (annotation.length == 0) { + return defaultValue; + } + if (annotation.length > 1) { + throw new AknotException("Must not have more than 1 element @AknotDefaultAttibute on " + classType.getClass().getCanonicalName()); + } + return ((AknotDefaultAttribute) annotation[0]).value(); + } + + public static Boolean getIsDefaultCaseSensitive(final Class classType, final Boolean defaultValue) throws AknotException { + final Annotation[] annotation = classType.getDeclaredAnnotationsByType(AknotDefaultCaseSensitive.class); + if (annotation.length == 0) { + return defaultValue; + } + if (annotation.length > 1) { + throw new AknotException("Must not have more than 1 element @AknotDefaultCaseSensitive on " + classType.getClass().getCanonicalName()); + } + return ((AknotDefaultCaseSensitive) annotation[0]).value(); + } + + public static Boolean getIsDefaultManaged(final Class classType, final Boolean defaultValue) throws AknotException { + final Annotation[] annotation = classType.getDeclaredAnnotationsByType(AknotDefaultManaged.class); + if (annotation.length == 0) { + return defaultValue; + } + if (annotation.length > 1) { + throw new AknotException("Must not have more than 1 element @AknotDefaultManaged on " + classType.getClass().getCanonicalName()); + } + return ((AknotDefaultManaged) annotation[0]).value(); + } + + public static Boolean getIsDefaultNullValue(final Class classType, final Boolean defaultValue) throws AknotException { + final Annotation[] annotation = classType.getDeclaredAnnotationsByType(AknotDefaultNullValue.class); + if (annotation.length == 0) { + return defaultValue; + } + if (annotation.length > 1) { + throw new AknotException("Must not have more than 1 element @AknotDefaultNullValue on " + classType.getClass().getCanonicalName()); + } + return ((AknotDefaultNullValue) annotation[0]).value(); + } + + public static Boolean getIsDefaultOptional(final Class classType, final Boolean defaultValue) throws AknotException { + final Annotation[] annotation = classType.getDeclaredAnnotationsByType(AknotDefaultOptional.class); + if (annotation.length == 0) { + return defaultValue; + } + if (annotation.length > 1) { + throw new AknotException("Must not have more than 1 element @AknotDefaultOptional on " + classType.getClass().getCanonicalName()); + } + return ((AknotDefaultOptional) annotation[0]).value(); + } + + public static Boolean getIsIgnoreUnknown(final Class classType, final Boolean defaultValue) throws AknotException { + final Annotation[] annotation = classType.getDeclaredAnnotationsByType(AknotIgnoreUnknown.class); + if (annotation.length == 0) { + return defaultValue; + } + if (annotation.length > 1) { + throw new AknotException("Must not have more than 1 element @AknotIgnoreUnknow on " + classType.getClass().getCanonicalName()); + } + return ((AknotIgnoreUnknown) annotation[0]).value(); + } + + public static Boolean getIsManaged(final Constructor constructor, final Parameter element, final Boolean parentValue) throws AknotException { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotManaged.class); + if (annotation.length == 0) { + return parentValue; + } + if (annotation.length > 1) { + throw new AknotException("Must not have more than 1 element @AknotManaged on " + constructor.getClass().getCanonicalName()); + } + return ((AknotManaged) annotation[0]).value(); + } + + public static Boolean getIsManaged(final Field element, final Boolean parentValue) throws AknotException { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotManaged.class); + if (annotation.length == 0) { + return parentValue; + } + if (annotation.length > 1) { + throw new AknotException("Must not have more than 1 element @ on " + element.getClass().getCanonicalName()); + } + return ((AknotManaged) annotation[0]).value(); + } + + public static Boolean getIsManaged(final Method element, final Boolean parentValue) throws AknotException { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotManaged.class); + if (annotation.length == 0) { + return parentValue; + } + if (annotation.length > 1) { + throw new AknotException("Must not have more than 1 element @AknotManaged on " + element.getClass().getCanonicalName()); + } + return ((AknotManaged) annotation[0]).value(); + } + + public static Boolean getIsOptional(final Constructor constructor, final Parameter element, final Boolean parentValue) throws AknotException { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotOptional.class); + if (annotation.length == 0) { + return parentValue; + } + if (annotation.length > 1) { + throw new AknotException("Must not have more than 1 element @AknotOptional on " + constructor.getClass().getCanonicalName()); + } + return ((AknotOptional) annotation[0]).value(); + } + + public static Boolean getIsOptional(final Field element, final Boolean parentValue) throws Exception { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotOptional.class); + if (annotation.length == 0) { + return parentValue; + } + if (annotation.length > 1) { + throw new Exception("Must not have more than 1 element @AknotOptional on " + element.getClass().getCanonicalName()); + } + return ((AknotOptional) annotation[0]).value(); + } + + public static Boolean getIsOptional(final Method element, final Boolean parentValue) throws Exception { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotOptional.class); + if (annotation.length == 0) { + return parentValue; + } + if (annotation.length > 1) { + throw new Exception("Must not have more than 1 element @AknotOptional on " + element.getClass().getCanonicalName()); + } + return ((AknotOptional) annotation[0]).value(); + } + + public static Boolean getIsSignal(final Field element, final Boolean parentValue) throws Exception { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotSignal.class); + if (annotation.length == 0) { + return parentValue; + } + if (annotation.length > 1) { + throw new Exception("Must not have more than 1 element @AknotSignal on " + element.getClass().getCanonicalName()); + } + return ((AknotSignal) annotation[0]).value(); + } + + public static Boolean getIsText(final Constructor constructor, final Parameter element, final Boolean parentValue) throws AknotException { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotText.class); + if (annotation.length == 0) { + return parentValue; + } + if (annotation.length > 1) { + throw new AknotException("Must not have more than 1 element @AknotText on " + constructor.getClass().getCanonicalName()); + } + return ((AknotText) annotation[0]).value(); + } + + public static Boolean getIsText(final Field element, final Boolean parentValue) throws AknotException { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotText.class); + if (annotation.length == 0) { + return parentValue; + } + if (annotation.length > 1) { + throw new AknotException("Must not have more than 1 element @AknotText on " + element.getClass().getCanonicalName()); + } + return ((AknotText) annotation[0]).value(); + } + + public static Boolean getIsText(final Method element, final Boolean parentValue) throws AknotException { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotText.class); + if (annotation.length == 0) { + return parentValue; + } + if (annotation.length > 1) { + throw new AknotException("Must not have more than 1 element @AknotText on " + element.getClass().getCanonicalName()); + } + return ((AknotText) annotation[0]).value(); + } + + public static String getListName(final Field element, final String defaultValue) throws Exception { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotList.class); + if (annotation.length == 0) { + return defaultValue; + } + if (annotation.length > 1) { + throw new Exception("Must not have more than 1 element @AknotList on " + element.getClass().getCanonicalName()); + } + final String tmp = ((AknotList) annotation[0]).value(); + if (tmp == null) { + throw new Exception("Set null value in decorator @AknotList is not availlable on: " + element.toGenericString()); + } + return tmp; + } + + public static String getListName(final Method element, final String defaultValue) throws Exception { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotList.class); + if (annotation.length == 0) { + return defaultValue; + } + if (annotation.length > 1) { + throw new Exception("Must not have more than 1 element @AknotList on " + element.getClass().getCanonicalName()); + } + final String tmp = ((AknotList) annotation[0]).value(); + if (tmp == null) { + throw new Exception("Set null value in decorator @AknotList is not availlable on: " + element.toGenericString()); + } + return tmp; + } + + public static String[] getNames(final Constructor constructor, final Parameter element, final String defaultValue) throws Exception { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotName.class); + if (annotation.length == 0) { + if (defaultValue == null) { + return null; + } + return new String[] { defaultValue }; + } + if (annotation.length > 1) { + throw new Exception("Must not have more than 1 element @AknotName on " + constructor.getClass().getCanonicalName()); + } + final String[] tmp = ((AknotName) annotation[0]).value(); + if (tmp == null) { + throw new Exception("Set null value in decorator @AknotName is not availlable on: " + constructor.toGenericString()); + } + if (tmp.length == 0) { + throw new Exception("Set empty list value in decorator @AknotName is not availlable on: " + constructor.toGenericString()); + } + for (final String elem : tmp) { + if (elem == null) { + throw new Exception("Set null String in list of value in decorator @AknotName is not availlable on: " + constructor.toGenericString()); + } + if (elem.isEmpty()) { + throw new Exception("Set empty String in list of value in decorator @AknotName is not availlable on: " + constructor.toGenericString()); + } + } + return tmp; + } + + public static String[] getNames(final Constructor element, final String defaultValue) throws Exception { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotName.class); + if (annotation.length == 0) { + if (defaultValue == null) { + return null; + } + return new String[] { defaultValue }; + } + if (annotation.length > 1) { + throw new Exception("Must not have more than 1 element @AknotName on " + element.getClass().getCanonicalName()); + } + final String[] tmp = ((AknotName) annotation[0]).value(); + if (tmp == null) { + throw new Exception("Set null value in decorator @AknotName is not availlable on: " + element.toGenericString()); + } + if (tmp.length == 0) { + throw new Exception("Set empty list value in decorator @AknotName is not availlable on: " + element.toGenericString()); + } + for (final String elem : tmp) { + if (elem == null) { + throw new Exception("Set null String in list of value in decorator @AknotName is not availlable on: " + element.toGenericString()); + } + if (elem.isEmpty()) { + throw new Exception("Set empty String in list of value in decorator @AknotName is not availlable on: " + element.toGenericString()); + } + } + return tmp; + } + + public static String[] getNames(final Field element, final String defaultValue) throws Exception { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotName.class); + if (annotation.length == 0) { + if (defaultValue == null) { + return null; + } + return new String[] { defaultValue }; + } + if (annotation.length > 1) { + throw new Exception("Must not have more than 1 element @AknotName on " + element.getClass().getCanonicalName()); + } + final String[] tmp = ((AknotName) annotation[0]).value(); + if (tmp == null) { + throw new Exception("Set null value in decorator @AknotName is not availlable on: " + element.toGenericString()); + } + if (tmp.length == 0) { + throw new Exception("Set empty list value in decorator @AknotName is not availlable on: " + element.toGenericString()); + } + for (final String elem : tmp) { + if (elem == null) { + throw new Exception("Set null String in list of value in decorator @AknotName is not availlable on: " + element.toGenericString()); + } + if (elem.isEmpty()) { + throw new Exception("Set empty String in list of value in decorator @AknotName is not availlable on: " + element.toGenericString()); + } + } + return tmp; + } + + public static String[] getNames(final Method element, final String defaultValue) throws Exception { + final Annotation[] annotation = element.getDeclaredAnnotationsByType(AknotName.class); + if (annotation.length == 0) { + if (defaultValue == null) { + return null; + } + return new String[] { defaultValue }; + } + if (annotation.length > 1) { + throw new Exception("Must not have more than 1 element @AknotName on " + element.getClass().getCanonicalName()); + } + final String[] tmp = ((AknotName) annotation[0]).value(); + if (tmp == null) { + throw new Exception("Set null value in decorator @AknotName is not availlable on: " + element.toGenericString()); + } + if (tmp.length == 0) { + throw new Exception("Set empty list value in decorator @AknotName is not availlable on: " + element.toGenericString()); + } + for (final String elem : tmp) { + if (elem == null) { + throw new Exception("Set null String in list of value in decorator @AknotName is not availlable on: " + element.toGenericString()); + } + if (elem.isEmpty()) { + throw new Exception("Set empty String in list of value in decorator @AknotName is not availlable on: " + element.toGenericString()); + } + } + return tmp; + } + + public static Class[] getTypeField(final Field fieldDescription) { + final Class type = fieldDescription.getType(); + Class subType = null; + final Type empppe = fieldDescription.getGenericType(); + if (empppe instanceof final ParameterizedType plopppppp) { + final Type[] realType = plopppppp.getActualTypeArguments(); + if (realType.length > 0) { + try { + subType = Class.forName(realType[0].getTypeName()); + } catch (final ClassNotFoundException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + } + } + } + return new Class[] { type, subType }; + } + + public static Class[] getTypeParameterfunction(final Constructor elem, final int paramId) throws ClassNotFoundException { + Class type = null; + Class subType = null; + + type = elem.getParameters()[paramId].getType(); + if (List.class.isAssignableFrom(type)) { + Class internalModelClass = null; + final Type[] empppe = elem.getGenericParameterTypes(); + if (empppe.length > paramId) { + if (empppe[paramId] instanceof final ParameterizedType plopppppp) { + final Type[] realType = plopppppp.getActualTypeArguments(); + //Log.info("ppplllppp: " + realType.length); + if (realType.length > 0) { + Log.verbose(" -->> " + realType[0]); + internalModelClass = Class.forName(realType[0].getTypeName()); + } + } + } + subType = internalModelClass; + } + return new Class[] { type, subType }; + } + + public static Class[] getTypeParameterfunction(final Method setter) throws Exception { + Class type = null; + Class subType = null; + + type = setter.getParameters()[0].getType(); + if (List.class.isAssignableFrom(type)) { + Class internalModelClass = null; + final Type[] empppe = setter.getGenericParameterTypes(); + if (empppe.length > 0) { + if (empppe[0] instanceof final ParameterizedType plopppppp) { + final Type[] realType = plopppppp.getActualTypeArguments(); + if (realType.length > 0) { + Log.verbose(" -->> " + realType[0]); + internalModelClass = Class.forName(realType[0].getTypeName()); + } + } + } + subType = internalModelClass; + } + return new Class[] { type, subType }; + } + + public static Class[] getTypeReturnFunction(/*@NotNull*/ final Method getter) throws Exception { + Class type = null; + Class subType = null; + type = getter.getReturnType(); + if (!Enum.class.isAssignableFrom(type)) { + final Type empppe = getter.getGenericReturnType(); + if (empppe instanceof final ParameterizedType plopppppp) { + final Type[] realType = plopppppp.getActualTypeArguments(); + if (realType.length > 0) { + subType = Class.forName(realType[0].getTypeName()); + } + } + } + return new Class[] { type, subType }; + } + + private ReflectTools() {} + +} diff --git a/test/src/test/atriasoft/aknot/ExmlTestElement.java b/test/src/test/atriasoft/aknot/ExmlTestElement.java new file mode 100644 index 0000000..cdb7d42 --- /dev/null +++ b/test/src/test/atriasoft/aknot/ExmlTestElement.java @@ -0,0 +1,35 @@ +/** @file + * @author Edouard DUPIN + * @copyright 2021, Edouard DUPIN, all right reserved + * @license MPL v2.0 (see license file) + */ +package test.atriasoft.aknot; + +import org.atriasoft.aknot.internal.Log; +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +public class ExmlTestElement { + @BeforeAll + public static void beforeClass() { + Log.verbose("----------------------------------------------------------------"); + } + + @Test + public void append() { + /* + final XmlElement myElement = new XmlElement("NodeName"); + Assertions.assertEquals(myElement.getNodes().size(), 0); + myElement.append(new XmlElement("jkjhkjhkh")); + Assertions.assertEquals(myElement.getNodes().size(), 1); + try { + myElement.getNode("jkjhkjhkh"); + } catch (final ExmlNodeDoesNotExist e) { + Assertions.fail("Should Not have thrown an exception"); + } + */ + Assertions.assertEquals(156, 1); + } + +} diff --git a/version.txt b/version.txt new file mode 100644 index 0000000..6c6aa7c --- /dev/null +++ b/version.txt @@ -0,0 +1 @@ +0.1.0 \ No newline at end of file