3 # Copyright (c) 2018 Cisco and/or its affiliates.
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at:
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
15 from string import Template
17 from jvpp_model import is_array
20 def generate_fields(fields, access_modifier="public"):
21 return "\n".join(_FIELD_TEMPLATE
22 .substitute(access_modifier=access_modifier, type=f.type.java_name_fqn, name=f.java_name)
25 _FIELD_TEMPLATE = Template(""" ${access_modifier} ${type} ${name};""")
28 def generate_hash_code(fields):
29 if len(fields) == 1 and is_array(fields[0]):
30 return _HASH_CODE_SINGLE_ARRAY_TEMPLATE.substitute(array_field=fields[0].java_name)
31 return _HASH_CODE_TEMPLATE.substitute(fields=", ".join(f.java_name for f in fields))
33 _HASH_CODE_TEMPLATE = Template("""
35 @io.fd.vpp.jvpp.coverity.SuppressFBWarnings("UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD")
36 public int hashCode() {
37 return java.util.Objects.hash($fields);
40 _HASH_CODE_SINGLE_ARRAY_TEMPLATE = Template("""
42 @io.fd.vpp.jvpp.coverity.SuppressFBWarnings("UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD")
43 public int hashCode() {
44 return java.util.Arrays.hashCode($array_field);
48 def generate_equals(class_name, fields):
52 comparisons.append(_EQUALS_ARRAY_FIELD_TEMPLATE.substitute(field_name=f.java_name))
54 comparisons.append(_EQUALS_FIELD_TEMPLATE.substitute(field_name=f.java_name))
57 comparisons.insert(0, _EQUALS_OTHER_TEMPLATE.substitute(cls_name=class_name))
58 return _EQUALS_TEMPLATE.substitute(comparisons="\n".join(comparisons))
60 _EQUALS_TEMPLATE = Template("""
62 public boolean equals(final Object o) {
66 if (o == null || getClass() != o.getClass()) {
74 _EQUALS_OTHER_TEMPLATE = Template("""
75 final $cls_name other = ($cls_name) o;
78 _EQUALS_FIELD_TEMPLATE = Template(""" if (!java.util.Objects.equals(this.$field_name, other.$field_name)) {
82 _EQUALS_ARRAY_FIELD_TEMPLATE = Template(""" if (!java.util.Arrays.equals(this.$field_name, other.$field_name)) {
87 def generate_to_string(class_name, fields):
91 to_string.append(_TO_STRING_ARRAY_FIELD_TEMPLATE.substitute(field_name=f.java_name))
93 to_string.append(_TO_STRING_FIELD_TEMPLATE.substitute(field_name=f.java_name))
95 to_string_fields = " \"}\";"
97 to_string_fields = " + \", \" +\n".join(to_string) + " + \"}\";"
99 return _TO_STRING_TEMPLATE.substitute(
100 class_name=class_name,
101 to_string_fields=to_string_fields
104 _TO_STRING_TEMPLATE = Template("""
106 public String toString() {
107 return "$class_name{" +
111 _TO_STRING_FIELD_TEMPLATE = Template(""" \"$field_name=\" + $field_name""")
113 _TO_STRING_ARRAY_FIELD_TEMPLATE = Template(
114 """ \"$field_name=\" + java.util.Arrays.toString($field_name)""")