2 * Copyright (c) 2018 Pantheon Technologies, s.r.o. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.mdsal.binding.java.api.generator;
10 import static com.google.common.base.Verify.verify;
11 import static java.util.Objects.requireNonNull;
13 import java.util.Arrays;
14 import java.util.List;
16 import java.util.Objects;
17 import java.util.Optional;
18 import java.util.regex.Pattern;
19 import java.util.stream.Collectors;
20 import org.eclipse.jdt.annotation.NonNull;
21 import org.opendaylight.mdsal.binding.model.api.ConcreteType;
22 import org.opendaylight.mdsal.binding.model.api.GeneratedProperty;
23 import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject;
24 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
25 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
26 import org.opendaylight.mdsal.binding.model.api.ParameterizedType;
27 import org.opendaylight.mdsal.binding.model.api.Restrictions;
28 import org.opendaylight.mdsal.binding.model.api.Type;
29 import org.opendaylight.mdsal.binding.model.util.Types;
30 import org.opendaylight.yangtools.yang.binding.CodeHelpers;
33 * Base Java file template. Contains a non-null type and imports which the generated code refers to.
35 class JavaFileTemplate {
37 * {@code java.lang.Class} as a JavaTypeName.
39 static final @NonNull JavaTypeName CLASS = JavaTypeName.create(Class.class);
41 * {@code java.lang.Deprecated} as a JavaTypeName.
43 static final @NonNull JavaTypeName DEPRECATED = JavaTypeName.create(Deprecated.class);
45 * {@code java.lang.Override} as a JavaTypeName.
47 static final @NonNull JavaTypeName OVERRIDE = JavaTypeName.create(Override.class);
50 * {@code java.lang.SuppressWarnings} as a JavaTypeName.
52 static final @NonNull JavaTypeName SUPPRESS_WARNINGS = JavaTypeName.create(SuppressWarnings.class);
55 * {@code java.util.Arrays} as a JavaTypeName.
57 static final @NonNull JavaTypeName JU_ARRAYS = JavaTypeName.create(Arrays.class);
59 * {@code java.util.List} as a JavaTypeName.
61 static final @NonNull JavaTypeName JU_LIST = JavaTypeName.create(List.class);
63 * {@code java.util.Map} as a JavaTypeName.
65 static final @NonNull JavaTypeName JU_MAP = JavaTypeName.create(Map.class);
67 * {@code java.util.Objects} as a JavaTypeName.
69 static final @NonNull JavaTypeName JU_OBJECTS = JavaTypeName.create(Objects.class);
71 * {@code java.util.regex.Pattern} as a JavaTypeName.
73 static final @NonNull JavaTypeName JUR_PATTERN = JavaTypeName.create(Pattern.class);
76 * {@code org.eclipse.jdt.annotation.NonNull} as a JavaTypeName.
78 static final @NonNull JavaTypeName NONNULL = JavaTypeName.create("org.eclipse.jdt.annotation", "NonNull");
80 * {@code org.eclipse.jdt.annotation.Nullable} as a JavaTypeName.
82 static final @NonNull JavaTypeName NULLABLE = JavaTypeName.create("org.eclipse.jdt.annotation", "Nullable");
85 * {@code org.opendaylight.yangtools.yang.binding.CodeHelpers} as a JavaTypeName.
87 static final @NonNull JavaTypeName CODEHELPERS = JavaTypeName.create(CodeHelpers.class);
89 private final AbstractJavaGeneratedType javaType;
90 private final GeneratedType type;
92 JavaFileTemplate(final @NonNull GeneratedType type) {
93 this(new TopLevelJavaGeneratedType(type), type);
96 JavaFileTemplate(final AbstractJavaGeneratedType javaType, final GeneratedType type) {
97 this.javaType = requireNonNull(javaType);
98 this.type = requireNonNull(type);
101 final AbstractJavaGeneratedType javaType() {
105 final GeneratedType type() {
109 final GeneratedProperty findProperty(final GeneratedTransferObject gto, final String name) {
110 final Optional<GeneratedProperty> optProp = gto.getProperties().stream()
111 .filter(prop -> prop.getName().equals(name)).findFirst();
112 if (optProp.isPresent()) {
113 return optProp.get();
116 final GeneratedTransferObject parent = gto.getSuperType();
117 return parent != null ? findProperty(parent, name) : null;
120 final String generateImportBlock() {
121 verify(javaType instanceof TopLevelJavaGeneratedType);
122 return ((TopLevelJavaGeneratedType) javaType).imports().map(name -> "import " + name + ";\n")
123 .collect(Collectors.joining());
126 final @NonNull String importedJavadocName(final @NonNull Type intype) {
127 return importedName(intype instanceof ParameterizedType ? ((ParameterizedType) intype).getRawType() : intype);
130 final @NonNull String importedName(final @NonNull Type intype) {
131 return javaType.getReferenceString(intype);
134 final @NonNull String importedName(final @NonNull Type intype, final @NonNull String annotation) {
135 return javaType.getReferenceString(intype, annotation);
138 final @NonNull String importedName(final Class<?> cls) {
139 return importedName(Types.typeForClass(cls));
142 final @NonNull String importedName(final @NonNull JavaTypeName intype) {
143 return javaType.getReferenceString(intype);
146 final @NonNull String importedNonNull(final @NonNull Type intype) {
147 return importedName(intype, importedName(NONNULL));
150 final @NonNull String importedNullable(final @NonNull Type intype) {
151 return importedName(intype, importedName(NULLABLE));
154 // Exposed for BuilderTemplate
155 boolean isLocalInnerClass(final JavaTypeName name) {
156 final Optional<JavaTypeName> optEnc = name.immediatelyEnclosingClass();
157 return optEnc.isPresent() && type.getIdentifier().equals(optEnc.get());
160 final CharSequence generateInnerClass(final GeneratedType innerClass) {
161 if (!(innerClass instanceof GeneratedTransferObject)) {
165 final GeneratedTransferObject gto = (GeneratedTransferObject) innerClass;
166 final NestedJavaGeneratedType innerJavaType = javaType.getEnclosedType(innerClass.getIdentifier());
167 return gto.isUnionType() ? new UnionTemplate(innerJavaType, gto).generateAsInnerClass()
168 : new ClassTemplate(innerJavaType, gto).generateAsInnerClass();
172 * Return imported name of java.util class, whose hashCode/equals methods we want to invoke on the property. Returns
173 * {@link Arrays} if the property is an array, {@link Objects} otherwise.
175 * @param property Generated property
176 * @return Imported class name
178 final String importedUtilClass(final GeneratedProperty property) {
179 return importedName(property.getReturnType().getName().indexOf('[') != -1 ? JU_ARRAYS : JU_OBJECTS);
182 static final Restrictions restrictionsForSetter(final Type actualType) {
183 return actualType instanceof GeneratedType ? null : getRestrictions(actualType);
186 static final Restrictions getRestrictions(final Type type) {
187 if (type instanceof ConcreteType) {
188 return ((ConcreteType) type).getRestrictions();
190 if (type instanceof GeneratedTransferObject) {
191 return ((GeneratedTransferObject) type).getRestrictions();