https://jira.opendaylight.org This file is an XML representation of an issue en-us 8.20.10 820010 22-06-2022 https://jira.opendaylight.org/browse/MDSAL-52 mdsal <p>Binding Java API Generator doesn't handle non-alphabetic signs in names of enum constants, allowed by rfc6020 though.</p> <p>As an output of this issue, we're not able to compile generated code.</p> <p>Operating System: All<br/> Platform: All</p> MDSAL-52

Binding Java API Generator -> doesn't handle non-alphabetic signs in names of enum constants, allowed by rfc6020 though

Bug Resolved Done Jakub Toth Martin Ciglan Thu, 6 Nov 2014 12:42:49 +0000 Fri, 9 Mar 2018 18:00:04 +0000 Wed, 26 Apr 2017 08:22:27 +0000 0 7 <p>I am adding some kind of proposal how should we handle this issue. </p> <p>public class NonAlphabeticHandler {</p> <p>//give occurence enum constants meanings<br/> private static final String ASTERISK_PATTERN = "<br class="atl-forced-newline" />*";<br/> private static final String ASTERISK_REPLACEMENT = "_OccurenceZeroOrMultipleTimes";</p> <p>private static final String PLUS_PATTERN = "<br class="atl-forced-newline" />+";<br/> private static final String PLUS_REPLACEMENT = "_OccurenceAtLeastOnce";</p> <p>private static final String ONE_PATTERN = "1";<br/> private static final String ONE_REPLACEMENT = "_OccurenceExactlyOnce";</p> <p>private static final String QUESTIONMARK_PATTERN = "<br class="atl-forced-newline" />?";<br/> private static final String QUESTIONMARK_REPLACEMENT = "_OccurenceZeroOrOneTime";</p> <p>//might get deleted and be part of generic one, detected it in name of protocol<br/> private static final String COLON_PATTERN = ":";<br/> private static final String COLON_REPLACEMENT = "_Colon";</p> <p>private static final String GENERIC_PATTERN = "<span class="error">&#91;^A-Za-z0-9&#93;</span>";<br/> private static final String GENERIC_REPLACEMENT = "_GenericNonAlpha";</p> <p>/**</p> <ul> <li>This static method takes className as an input argument and looks for non-alphabetic signs in it.</li> <li>It aims to replace them in order to get valid Java class names and be able to compile them.</li> <li>Indicate by underscore sign ('_') that replacement has been made up.</li> <li>I propose to give meaning to replacements to mimic occurence enum constants names like '*', '?', '+', etc...</li> <li>Test implementation with various inputs to see coverage area and performance.</li> <li></li> <li>@param className</li> <li>@return className<br/> */<br/> public static String getValidClassName(String className) { String backup = className; className = className.replaceAll(ASTERISK_PATTERN, ASTERISK_REPLACEMENT); if (!className.equals(backup)) return className; className = className.replaceAll(COLON_PATTERN, COLON_REPLACEMENT); if (!className.equals(backup)) return className; className = className.replaceAll(PLUS_PATTERN, PLUS_REPLACEMENT); if (!className.equals(backup)) return className; className = className.replaceAll(ONE_PATTERN, ONE_REPLACEMENT); if (!className.equals(backup)) return className; className = className.replaceAll(QUESTIONMARK_PATTERN, QUESTIONMARK_REPLACEMENT); if (!className.equals(backup)) return className; className = className.replaceAll(GENERIC_PATTERN, GENERIC_REPLACEMENT); if (!className.equals(backup)) return className; return className; }</li> </ul> <p> public static void main(String[] args) {<br/> String className = "+";</p> <p> System.out.public class NonAlphabeticHandler {println(System.currentTimeMillis());<br/> System.out.println(className + " -&gt; " + NonAlphabeticHandler.getValidClassName(className));<br/> System.out.println(System.currentTimeMillis() + "\n");</p> <p> className = "Tdp:";</p> <p> System.out.println(System.currentTimeMillis());<br/> System.out.println(className + " -&gt; " + NonAlphabeticHandler.getValidClassName(className));<br/> System.out.println(System.currentTimeMillis() + "\n") <br/> .</p> <p>.<br/> .<br/> .<br/> }</p> <p>Note: Not sure about nonalphabetic signs, which are part of words like device names, perhaps Device+ -&gt; Device_Plus would be more reasonable. Of course, it's matter of discussion in team.</p> <p>in very first draft phase</p> <p>Hi Martin,</p> <p>I see that you actively have "taken" this one... is that still applicable? If not, please let me know so that I can take a look.</p> <p>Thanks,<br/> Ryan</p> <p>Hi Ryan</p> <p>This is one of several bugs, which we have identified during work with binding specification version 1. This issue depends on implementation of binding specification version 2, please see<br/> <a href="https://bugs.opendaylight.org/show_bug.cgi?id=1411" class="external-link" target="_blank" rel="nofollow noopener">https://bugs.opendaylight.org/show_bug.cgi?id=1411</a></p> <p>So, once 1411 is resolved, this should get resolved too. I hope that helps.</p> <p> Martin</p> <p>Java binding v2 will not be ported to Beryllium, as far as I know.</p> <p>In the meantime, it is possible to somewhat reduce severity of this Bug.<br/> <a href="https://git.opendaylight.org/gerrit/41280" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/41280</a></p> <p>&gt; it is possible to somewhat reduce severity</p> <p>Merged to master (Boron and Carbon): <a href="https://git.opendaylight.org/gerrit/41280" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/41280</a></p> <p>Waiting for review for Beryllium: <a href="https://git.opendaylight.org/gerrit/44481" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/44481</a></p> <p>&gt; Beryllium: <a href="https://git.opendaylight.org/gerrit/44481" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/44481</a></p> <p>The workaround is now merged. Other characters aside slash have to be handled separately (possibly only in Java binding v2).</p> <p><a href="https://git.opendaylight.org/gerrit/#/c/51132/" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/#/c/51132/</a></p> Blocks MDSAL-40 Duplicate YANGTOOLS-599 Development External References mdsal_bindingv1_txt_run_maven External issue ID 2332 External issue URL Issue Type ODL SR Target Milestone Rank 0|i02w0n: