Skip to content

Lda/fix abstract class builder #139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
0-ace-l0 wants to merge 5 commits into
base: dev
Choose a base branch
from
Draft

Lda/fix abstract class builder #139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f11120e
add CDAssociationModifierCoCo to prevent visibility conflicts in CDAs…
0-ace-l0 Sep 4, 2026
d5edace
in progress: support additional modifiers for Associations in CDAssoc…
0-ace-l0 Sep 4, 2026
027b75a
forbid static modifier for associations in CDAssociationModifierCoCo.…
0-ace-l0 Sep 9, 2026
5aef8b3
still in progress: omit build() from BuilderDecorator.java to prevent…
0-ace-l0 Sep 21, 2026
bf7892f
spotlessApply
0-ace-l0 Sep 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
197 changes: 100 additions & 97 deletions cdlang/src/main/java/de/monticore/cd/codegen/decorators/BuilderDecorator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,108 +78,111 @@ public void visit(ASTCDClass node) {
// Get decorated pojo class
ASTCDClass decClazz = this.decoratorData.getAsDecorated(node);

// Create a new class with the "Builder" suffix
ASTCDClassBuilder builderClassB = CD4CodeMill.cDClassBuilder();
builderClassB.setName(node.getName() + "Builder");
builderClassB.setModifier(node.getModifier().deepClone());
ASTCDClass builderClass = builderClassB.build();
// Add the builder class to the decorated CD
addElementToParent(decParent, builderClass);

// Add Log import to the builder class
CD4C.getInstance().addImport(builderClass, "de.se_rwth.commons.logging.Log");

// Add builder attribute for TOP safety
builderClass.addCDMember(CDAttributeFacade.getInstance().createAttribute(CD4CodeMill
.modifierBuilder().PROTECTED().build(), builderClass.getName(), "realBuilder"));

// Add a constructor to the builder class
ASTCDConstructor constructor = CDConstructorFacade.getInstance().createConstructor(CD4CodeMill
.modifierBuilder().PUBLIC().build(), builderClass.getName());
glexOpt.ifPresent(glex -> glex.replaceTemplate(EMPTY_BODY, constructor, new StringHookPoint(
"this.realBuilder = (" + builderClass.getName() + ") this;")));
addToClass(builderClass, constructor);

// Add a isValid() method to the builder class
List<ASTCDAttribute> allAttributeList = getAllCDAttributes(node);
String staticErrorCode = "0x16725";
ASTCDMethod isValidMethod = CDMethodFacade.getInstance().createMethod(CD4CodeMill
.modifierBuilder().PRIVATE().build(), MCTypeFacade.getInstance().createBooleanType(),
"isValid");
glexOpt.ifPresent(glex -> glex.replaceTemplate(EMPTY_BODY, isValidMethod,
new TemplateHookPoint("methods.builder.isValid", allAttributeList, staticErrorCode)));
addToClass(builderClass, isValidMethod);

// Add a build() method to the builder class
ASTCDMethod buildMethod = CDMethodFacade.getInstance().createMethod(CD4CodeMill
.modifierBuilder().PUBLIC().build(), node.getName(), "build");
glexOpt.ifPresent(glex -> glex.replaceTemplate(EMPTY_BODY, buildMethod, new TemplateHookPoint(
"methods.builder.build", node.getName())));
addToClass(builderClass, buildMethod);

// Add the unsafeBuild() method to the builder class
ASTCDMethod unsafeBuildMethod = CDMethodFacade.getInstance().createMethod(CD4CodeMill
.modifierBuilder().PUBLIC().build(), node.getName(), "unsafeBuild");
glexOpt.ifPresent(glex -> glex.replaceTemplate(EMPTY_BODY, unsafeBuildMethod,
new TemplateHookPoint("methods.builder.unsafeBuild", node.getName())));
addToClass(builderClass, unsafeBuildMethod);

// Add attributes to the builder class
for (ASTCDAttribute attribute : allAttributeList) {
if (!(node.getModifier().isAbstract())) {
// Create a new class with the "Builder" suffix
ASTCDClassBuilder builderClassB = CD4CodeMill.cDClassBuilder();
builderClassB.setName(node.getName() + "Builder");
builderClassB.setModifier(node.getModifier().deepClone());
ASTCDClass builderClass = builderClassB.build();
// Add the builder class to the decorated CD
addElementToParent(decParent, builderClass);

// Add Log import to the builder class
CD4C.getInstance().addImport(builderClass, "de.se_rwth.commons.logging.Log");

// Add builder attribute for TOP safety
builderClass.addCDMember(CDAttributeFacade.getInstance().createAttribute(CD4CodeMill
.modifierBuilder().PROTECTED().build(), attribute.getMCType(), attribute.getName()));
}

// Add setter methods to the builder class
for (ASTCDAttribute attribute : allAttributeList) {
ASTCDParameter param = CD4CodeMill.cDParameterBuilder().setName(attribute.getName())
.setMCType(attribute.getMCType()).build();
if (dispatcher.isMCCollectionTypesASTMCOptionalType(attribute.getMCType())) {
//set of optional with type directly and not with optional<type>
ASTMCType type = getCDGenService().getFirstTypeArgument(attribute.getMCType())
.deepClone();
param = CD4CodeMill.cDParameterBuilder().setName(attribute.getName()).setMCType(type)
.build();
}
ASTCDMethod setMethod = CDMethodFacade.getInstance().createMethod(CD4CodeMill
.modifierBuilder().PUBLIC().build(), builderClass.getName(), "set"
+ StringTransformations.capitalize(attribute.getName()), param);
glexOpt.ifPresent(glex -> glex.replaceTemplate(EMPTY_BODY, setMethod, new TemplateHookPoint(
"methods.builder.set", attribute)));
addToClass(builderClass, setMethod);
.modifierBuilder().PROTECTED().build(), builderClass.getName(), "realBuilder"));

// it is required to check if a setter method exists by checking the methods of the SetterDecorator for
// an exact match of "set" + attribute.getName()
// if this method does not exist,
// we need to reference the attribute directly in the build method
boolean hasSetterMethod;
List<SetterDecorator.MethodInformation> methods = decoratorData.getDecoratorData(
SetterDecorator.class) != null ? decoratorData.getDecoratorData(SetterDecorator.class)
.getMethods(attribute) : List.of();
hasSetterMethod = methods.stream().anyMatch(mi -> mi.getKind()
== SetterDecorator.SetterMethodKind.SET_MANDATORY_OR_OPT);
// Add a constructor to the builder class
ASTCDConstructor constructor = CDConstructorFacade.getInstance().createConstructor(
CD4CodeMill.modifierBuilder().PUBLIC().build(), builderClass.getName());
glexOpt.ifPresent(glex -> glex.replaceTemplate(EMPTY_BODY, constructor, new StringHookPoint(
"this.realBuilder = (" + builderClass.getName() + ") this;")));
addToClass(builderClass, constructor);

// Add set attributes in the build method
glexOpt.ifPresent(glex -> glex.addAfterTemplate("methods.builder.build:Inner", buildMethod,
new TemplateHookPoint("methods.builder.setAttribute", attribute, hasSetterMethod)));
// Add a isValid() method to the builder class
List<ASTCDAttribute> allAttributeList = getAllCDAttributes(node);
String staticErrorCode = "0x16725";
ASTCDMethod isValidMethod = CDMethodFacade.getInstance().createMethod(CD4CodeMill
.modifierBuilder().PRIVATE().build(), MCTypeFacade.getInstance().createBooleanType(),
"isValid");
glexOpt.ifPresent(glex -> glex.replaceTemplate(EMPTY_BODY, isValidMethod,
new TemplateHookPoint("methods.builder.isValid", allAttributeList, staticErrorCode)));
addToClass(builderClass, isValidMethod);

// Add set attributes in the unsafeBuild method
glexOpt.ifPresent(glex -> glex.addAfterTemplate("methods.builder.unsafeBuild:Inner",
unsafeBuildMethod, new TemplateHookPoint("methods.builder.setAttribute", attribute,
hasSetterMethod)));
}

// Add isAbsent methods for all attributes with cardinality != 1
for (ASTCDAttribute attribute : allAttributeList) {
if (dispatcher.isMCCollectionTypesASTMCListType(attribute.getMCType()) || dispatcher
.isMCCollectionTypesASTMCOptionalType(attribute.getMCType()) || dispatcher
.isMCCollectionTypesASTMCSetType(attribute.getMCType())) {
ASTCDMethod setAbsentMethod = CDMethodFacade.getInstance().createMethod(CD4CodeMill
// Add a build() method to the builder class
ASTCDMethod buildMethod = CDMethodFacade.getInstance().createMethod(CD4CodeMill
.modifierBuilder().PUBLIC().build(), node.getName(), "build");
glexOpt.ifPresent(glex -> glex.replaceTemplate(EMPTY_BODY, buildMethod,
new TemplateHookPoint("methods.builder.build", node.getName())));
addToClass(builderClass, buildMethod);

// Add the unsafeBuild() method to the builder class
ASTCDMethod unsafeBuildMethod = CDMethodFacade.getInstance().createMethod(CD4CodeMill
.modifierBuilder().PUBLIC().build(), node.getName(), "unsafeBuild");
glexOpt.ifPresent(glex -> glex.replaceTemplate(EMPTY_BODY, unsafeBuildMethod,
new TemplateHookPoint("methods.builder.unsafeBuild", node.getName())));
addToClass(builderClass, unsafeBuildMethod);

// Add attributes to the builder class
for (ASTCDAttribute attribute : allAttributeList) {
builderClass.addCDMember(CDAttributeFacade.getInstance().createAttribute(CD4CodeMill
.modifierBuilder().PROTECTED().build(), attribute.getMCType(), attribute.getName()));
}

// Add setter methods to the builder class
for (ASTCDAttribute attribute : allAttributeList) {
ASTCDParameter param = CD4CodeMill.cDParameterBuilder().setName(attribute.getName())
.setMCType(attribute.getMCType()).build();
if (dispatcher.isMCCollectionTypesASTMCOptionalType(attribute.getMCType())) {
//set of optional with type directly and not with optional<type>
ASTMCType type = getCDGenService().getFirstTypeArgument(attribute.getMCType())
.deepClone();
param = CD4CodeMill.cDParameterBuilder().setName(attribute.getName()).setMCType(type)
.build();
}
ASTCDMethod setMethod = CDMethodFacade.getInstance().createMethod(CD4CodeMill
.modifierBuilder().PUBLIC().build(), builderClass.getName(), "set"
+ StringTransformations.capitalize(attribute.getName()) + "Absent");
glexOpt.ifPresent(glex -> glex.replaceTemplate(EMPTY_BODY, setAbsentMethod,
new TemplateHookPoint("methods.builder.setAbsent", attribute)));
addToClass(builderClass, setAbsentMethod);
+ StringTransformations.capitalize(attribute.getName()), param);
glexOpt.ifPresent(glex -> glex.replaceTemplate(EMPTY_BODY, setMethod,
new TemplateHookPoint("methods.builder.set", attribute)));
addToClass(builderClass, setMethod);

// it is required to check if a setter method exists by checking the methods of the SetterDecorator for
// an exact match of "set" + attribute.getName()
// if this method does not exist,
// we need to reference the attribute directly in the build method
boolean hasSetterMethod;
List<SetterDecorator.MethodInformation> methods = decoratorData.getDecoratorData(
SetterDecorator.class) != null ? decoratorData.getDecoratorData(SetterDecorator.class)
.getMethods(attribute) : List.of();
hasSetterMethod = methods.stream().anyMatch(mi -> mi.getKind()
== SetterDecorator.SetterMethodKind.SET_MANDATORY_OR_OPT);

// Add set attributes in the build method
glexOpt.ifPresent(glex -> glex.addAfterTemplate("methods.builder.build:Inner",
buildMethod, new TemplateHookPoint("methods.builder.setAttribute", attribute,
hasSetterMethod)));

// Add set attributes in the unsafeBuild method
glexOpt.ifPresent(glex -> glex.addAfterTemplate("methods.builder.unsafeBuild:Inner",
unsafeBuildMethod, new TemplateHookPoint("methods.builder.setAttribute", attribute,
hasSetterMethod)));
}

// Add isAbsent methods for all attributes with cardinality != 1
for (ASTCDAttribute attribute : allAttributeList) {
if (dispatcher.isMCCollectionTypesASTMCListType(attribute.getMCType()) || dispatcher
.isMCCollectionTypesASTMCOptionalType(attribute.getMCType()) || dispatcher
.isMCCollectionTypesASTMCSetType(attribute.getMCType())) {
ASTCDMethod setAbsentMethod = CDMethodFacade.getInstance().createMethod(CD4CodeMill
.modifierBuilder().PUBLIC().build(), builderClass.getName(), "set"
+ StringTransformations.capitalize(attribute.getName()) + "Absent");
glexOpt.ifPresent(glex -> glex.replaceTemplate(EMPTY_BODY, setAbsentMethod,
new TemplateHookPoint("methods.builder.setAbsent", attribute)));
addToClass(builderClass, setAbsentMethod);
}
}
}

Expand Down
7 changes: 4 additions & 3 deletions .../main/java/de/monticore/cdassociation/_symboltable/CDAssociationSymbolTableCompleter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,12 +146,13 @@ public void endVisit(ASTCDAssociation node) {

public void setupModifiers(ASTModifier assocSideModifier, ASTModifier assocModifier,
CDRoleSymbol roleSymbol) {
roleSymbol.setIsPublic(assocSideModifier.isPublic() || assocModifier.isPublic());
roleSymbol.setIsPrivate(assocSideModifier.isPrivate() || assocModifier.isPrivate());
roleSymbol.setIsProtected(assocSideModifier.isProtected() || assocModifier.isProtected());
roleSymbol.setIsPublic(assocSideModifier.isPublic());
roleSymbol.setIsPrivate(assocSideModifier.isPrivate());
roleSymbol.setIsProtected(assocSideModifier.isProtected());
roleSymbol.setIsStatic(assocSideModifier.isStatic() || assocModifier.isStatic());
roleSymbol.setIsFinal(assocSideModifier.isFinal() || assocModifier.isFinal());
roleSymbol.setIsDerived(assocSideModifier.isDerived() || assocModifier.isDerived());
roleSymbol.setIsReadOnly(assocSideModifier.isReadonly() || assocModifier.isReadonly());
}

public static void addRoleToTheirType(CDRoleSymbol symbol, TypeSymbol otherType) {
Expand Down
1 change: 1 addition & 0 deletions cdlang/src/main/java/de/monticore/cdassociation/cocos/CDAssociationCoCos.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ protected void addEbnfCoCos(CDAssociationCoCoChecker checker) {
checker.addCoCo(new CDAssociationOrderedCardinalityGreaterOne());
checker.addCoCo(new CDAssociationRoleNameLowerCase());
checker.addCoCo(new CDAssociationRoleNameNoConflictWithLocalAttribute());
checker.addCoCo(new CDAssociationModifierCoCo());
}

}
58 changes: 58 additions & 0 deletions cdlang/src/main/java/de/monticore/cdassociation/cocos/ebnf/CDAssociationModifierCoCo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
/* (c) https://github.com/MontiCore/monticore */
package de.monticore.cdassociation.cocos.ebnf;

import de.monticore.cdassociation._ast.ASTCDAssociation;
import de.monticore.cdassociation._cocos.CDAssociationASTCDAssociationCoCo;
import de.monticore.umlmodifier._ast.ASTModifier;
import de.se_rwth.commons.logging.Log;

public class CDAssociationModifierCoCo implements CDAssociationASTCDAssociationCoCo {

@Override
public void check(ASTCDAssociation a) {

//----------------------------------check the visibility modifiers-----------------------------------------------------------
//main modifier
boolean hasMainVisibility = false;
if (a.getModifier() != null) {
ASTModifier mainModifier = a.getModifier();
hasMainVisibility = mainModifier.isPublic() || mainModifier.isProtected() || mainModifier
.isPrivate();
}

//left modifier
boolean hasLeftVisibility = false;
if (a.getLeft().getModifier() != null) {
ASTModifier leftModifier = a.getLeft().getModifier();
hasLeftVisibility = leftModifier.isPublic() || leftModifier.isProtected() || leftModifier
.isPrivate();
}

//right modifier
boolean hasRightVisibility = false;
if (a.getRight().getModifier() != null) {
ASTModifier rightModifier = a.getRight().getModifier();
hasRightVisibility = rightModifier.isPublic() || rightModifier.isProtected() || rightModifier
.isPrivate();
}

if (hasMainVisibility && (hasLeftVisibility || hasRightVisibility)) {
Log.warn(
"Association cannot combine a main visibility modifier with individual role visibility modifiers.",
a.get_SourcePositionStart());
}

//check whether the association or symbolRole use the static modifier
boolean mainStatic = a.getModifier() != null && a.getModifier().isStatic();
boolean leftStatic = a.getLeft().getModifier() != null && a.getLeft().getModifier().isStatic();
boolean rightStatic = a.getRight().getModifier() != null && a.getRight().getModifier()
.isStatic();

if (mainStatic || leftStatic || rightStatic) {
String assocName = a.isPresentName() ? a.getName() : "unnamed";
Log.error(String.format("0xCDA61: The association '%s' must not use static modifiers.",
assocName), a.get_SourcePositionStart());
}
}

}
Loading