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.Objects;
15 import java.util.Optional;
16 import java.util.stream.Collectors;
17 import org.opendaylight.mdsal.binding.model.api.ConcreteType;
18 import org.opendaylight.mdsal.binding.model.api.GeneratedProperty;
19 import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject;
20 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
21 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
22 import org.opendaylight.mdsal.binding.model.api.ParameterizedType;
23 import org.opendaylight.mdsal.binding.model.api.Restrictions;
24 import org.opendaylight.mdsal.binding.model.api.Type;
25 import org.opendaylight.mdsal.binding.model.util.Types;
28 * Base Java file template. Contains a non-null type and imports which the generated code refers to.
30 class JavaFileTemplate {
31 static final JavaTypeName NONNULL = JavaTypeName.create("org.eclipse.jdt.annotation", "NonNull");
32 static final JavaTypeName NULLABLE = JavaTypeName.create("org.eclipse.jdt.annotation", "Nullable");
33 static final JavaTypeName DEPRECATED = JavaTypeName.create(Deprecated.class);
34 static final JavaTypeName OVERRIDE = JavaTypeName.create(Override.class);
35 static final JavaTypeName SUPPRESS_WARNINGS = JavaTypeName.create(SuppressWarnings.class);
37 private final AbstractJavaGeneratedType javaType;
38 private final GeneratedType type;
40 JavaFileTemplate(final GeneratedType type) {
41 this(new TopLevelJavaGeneratedType(type), type);
44 JavaFileTemplate(final AbstractJavaGeneratedType javaType, final GeneratedType type) {
45 this.javaType = requireNonNull(javaType);
46 this.type = requireNonNull(type);
49 final AbstractJavaGeneratedType javaType() {
53 final GeneratedType type() {
57 final GeneratedProperty findProperty(final GeneratedTransferObject gto, final String name) {
58 final Optional<GeneratedProperty> optProp = gto.getProperties().stream()
59 .filter(prop -> prop.getName().equals(name)).findFirst();
60 if (optProp.isPresent()) {
64 final GeneratedTransferObject parent = gto.getSuperType();
65 return parent != null ? findProperty(parent, name) : null;
68 final String generateImportBlock() {
69 verify(javaType instanceof TopLevelJavaGeneratedType);
70 return ((TopLevelJavaGeneratedType) javaType).imports().map(name -> "import " + name + ";\n")
71 .collect(Collectors.joining());
74 final String importedJavadocName(final Type intype) {
75 return importedName(intype instanceof ParameterizedType ? ((ParameterizedType) intype).getRawType() : intype);
78 final String importedName(final Type intype) {
79 return javaType.getReferenceString(intype);
82 final String importedName(final Type intype, final String... annotations) {
83 return javaType.getReferenceString(intype, annotations);
86 final String importedName(final Class<?> cls) {
87 return importedName(Types.typeForClass(cls));
90 final String importedName(final JavaTypeName intype) {
91 return javaType.getReferenceString(intype);
94 final String importedNonNull(final Type intype) {
95 return importedName(intype, importedName(NONNULL));
98 final String importedNullable(final Type intype) {
99 return importedName(intype, importedName(NULLABLE));
102 final void addImport(final Class<?> cls) {
103 javaType.getReferenceString(JavaTypeName.create(cls));
106 // Exposed for BuilderTemplate
107 boolean isLocalInnerClass(final JavaTypeName name) {
108 final Optional<JavaTypeName> optEnc = name.immediatelyEnclosingClass();
109 return optEnc.isPresent() && type.getIdentifier().equals(optEnc.get());
112 final CharSequence generateInnerClass(final GeneratedType innerClass) {
113 if (!(innerClass instanceof GeneratedTransferObject)) {
117 final GeneratedTransferObject gto = (GeneratedTransferObject) innerClass;
118 final NestedJavaGeneratedType innerJavaType = javaType.getEnclosedType(innerClass.getIdentifier());
119 return gto.isUnionType() ? new UnionTemplate(innerJavaType, gto).generateAsInnerClass()
120 : new ClassTemplate(innerJavaType, gto).generateAsInnerClass();
124 * Return imported name of java.util class, whose hashCode/equals methods we want to invoke on the property. Returns
125 * {@link Arrays} if the property is an array, {@link Objects} otherwise.
127 * @param property Generated property
128 * @return Imported class name
130 final String importedUtilClass(final GeneratedProperty property) {
131 return importedName(property.getReturnType().getName().indexOf('[') != -1 ? Arrays.class : Objects.class);
134 static final Restrictions restrictionsForSetter(final Type actualType) {
135 return actualType instanceof GeneratedType ? null : getRestrictions(actualType);
138 static final Restrictions getRestrictions(final Type type) {
139 if (type instanceof ConcreteType) {
140 return ((ConcreteType) type).getRestrictions();
142 if (type instanceof GeneratedTransferObject) {
143 return ((GeneratedTransferObject) type).getRestrictions();