Skip to content

Commit

Permalink
Introduced useUnmodifiableCollections option
Browse files Browse the repository at this point in the history
  • Loading branch information
@pawellabaj
pawellabaj committed Jun 21, 2023
1 parent 7e9d447 commit 5836199
Show file tree
Hide file tree
Showing 6 changed files with 201 additions and 77 deletions.
18 changes: 18 additions & 0 deletions record-builder-core/src/main/java/io/soabase/recordbuilder/core/RecordBuilder.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -183,9 +183,27 @@
* {@link java.util.Map} and {@link java.util.Collection}. When the record is built, any components of these
* types are passed through an added shim method that uses the corresponding immutable collection (e.g.
* {@code List.copyOf(o)}) or an empty immutable collection if the component is {@code null}.
*
* @see #useUnmodifiableCollections()
*/
boolean useImmutableCollections() default false;

/**
* Adds special handling for record components of type: {@link java.util.List}, {@link java.util.Set},
* {@link java.util.Map} and {@link java.util.Collection}. When the record is built, any components of these
* types are passed through an added shim method that uses the corresponding unmodifiable collection (e.g.
* {@code Collections.unmodifiableList(o)}) or an empty immutable collection if the component is {@code null}.
*
* <p>
* For backward compatibility, when {@link #useImmutableCollections()} returns {@code true}, this property is
* ignored.
*
* @see #useImmutableCollections()
*
* @since 37
*/
boolean useUnmodifiableCollections() default false;

/**
* When enabled, collection types ({@code List}, {@code Set} and {@code Map}) are handled specially. The setters
* for these types now create an internal collection and items are added to that collection. Additionally,
Expand Down
124 changes: 89 additions & 35 deletions ...er-processor/src/main/java/io/soabase/recordbuilder/processor/CollectionBuilderUtils.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@

class CollectionBuilderUtils {
private final boolean useImmutableCollections;
private final boolean useUnmodifiableCollections;
private final boolean addSingleItemCollectionBuilders;
private final boolean addClassRetainedGenerated;
private final String listShimName;
Expand Down Expand Up @@ -81,6 +82,7 @@ class CollectionBuilderUtils {

CollectionBuilderUtils(List<RecordClassType> recordComponents, RecordBuilder.Options metaData) {
useImmutableCollections = metaData.useImmutableCollections();
useUnmodifiableCollections = !useImmutableCollections && metaData.useUnmodifiableCollections();
addSingleItemCollectionBuilders = metaData.addSingleItemCollectionBuilders();
addClassRetainedGenerated = metaData.addClassRetainedGenerated();

Expand Down Expand Up @@ -130,34 +132,34 @@ Optional<SingleItemsMetaData> singleItemsMetaData(RecordClassType component, Sin
var hasWildcardTypeArguments = hasWildcardTypeArguments(parameterizedTypeName, typeArgumentQty);
if (collectionClass != null) {
return switch (mode) {
case STANDARD -> singleItemsMetaDataWithWildType(parameterizedTypeName, collectionClass, wildcardClass,
typeArgumentQty);
case STANDARD -> singleItemsMetaDataWithWildType(parameterizedTypeName, collectionClass, wildcardClass,
typeArgumentQty);

case STANDARD_FOR_SETTER -> {
if (hasWildcardTypeArguments) {
yield Optional.of(new SingleItemsMetaData(collectionClass, parameterizedTypeName.typeArguments,
component.typeName()));
case STANDARD_FOR_SETTER -> {
if (hasWildcardTypeArguments) {
yield Optional.of(new SingleItemsMetaData(collectionClass, parameterizedTypeName.typeArguments,
component.typeName()));
}
yield singleItemsMetaDataWithWildType(parameterizedTypeName, collectionClass, wildcardClass,
typeArgumentQty);
}
yield singleItemsMetaDataWithWildType(parameterizedTypeName, collectionClass, wildcardClass,
typeArgumentQty);
}

case EXCLUDE_WILDCARD_TYPES -> {
if (hasWildcardTypeArguments) {
yield Optional.empty();
case EXCLUDE_WILDCARD_TYPES -> {
if (hasWildcardTypeArguments) {
yield Optional.empty();
}
yield singleItemsMetaDataWithWildType(parameterizedTypeName, collectionClass, wildcardClass,
typeArgumentQty);
}
yield singleItemsMetaDataWithWildType(parameterizedTypeName, collectionClass, wildcardClass,
typeArgumentQty);
}
};
}
}
return Optional.empty();
}

boolean isImmutableCollection(RecordClassType component) {
return useImmutableCollections && (isList(component) || isMap(component) || isSet(component)
|| component.rawTypeName().equals(collectionTypeName));
return (useImmutableCollections || useUnmodifiableCollections)
&& (isList(component) || isMap(component) || isSet(component) || isCollection(component));
}

boolean isList(RecordClassType component) {
Expand All @@ -172,8 +174,12 @@ boolean isSet(RecordClassType component) {
return component.rawTypeName().equals(setTypeName);
}

private boolean isCollection(RecordClassType component) {
return component.rawTypeName().equals(collectionTypeName);
}

void addShimCall(CodeBlock.Builder builder, RecordClassType component) {
if (useImmutableCollections) {
if (useImmutableCollections || useUnmodifiableCollections) {
if (isList(component)) {
needsListShim = true;
needsListMutableMaker = true;
Expand All @@ -186,7 +192,7 @@ void addShimCall(CodeBlock.Builder builder, RecordClassType component) {
needsSetShim = true;
needsSetMutableMaker = true;
builder.add("$L($L)", setShimName, component.name());
} else if (component.rawTypeName().equals(collectionTypeName)) {
} else if (isCollection(component)) {
needsCollectionShim = true;
builder.add("$L($L)", collectionShimName, component.name());
} else {
Expand All @@ -204,7 +210,7 @@ String shimName(RecordClassType component) {
return mapShimName;
} else if (isSet(component)) {
return setShimName;
} else if (component.rawTypeName().equals(collectionTypeName)) {
} else if (isCollection(component)) {
return collectionShimName;
} else {
throw new IllegalArgumentException(component + " is not a supported collection type");
Expand All @@ -224,7 +230,7 @@ String mutableMakerName(RecordClassType component) {
}

void addShims(TypeSpec.Builder builder) {
if (!useImmutableCollections) {
if (!useImmutableCollections && !useUnmodifiableCollections) {
return;
}

Expand All @@ -244,7 +250,7 @@ void addShims(TypeSpec.Builder builder) {
}

void addMutableMakers(TypeSpec.Builder builder) {
if (!useImmutableCollections) {
if (!useImmutableCollections && !useUnmodifiableCollections) {
return;
}

Expand All @@ -266,7 +272,7 @@ void addMutableMakers(TypeSpec.Builder builder) {
}

private Optional<SingleItemsMetaData> singleItemsMetaDataWithWildType(ParameterizedTypeName parameterizedTypeName,
Class<?> collectionClass, ClassName wildcardClass, int typeArgumentQty) {
Class<?> collectionClass, ClassName wildcardClass, int typeArgumentQty) {
TypeName wildType;
if (typeArgumentQty == 1) {
wildType = ParameterizedTypeName.get(wildcardClass,
Expand Down Expand Up @@ -299,13 +305,8 @@ private String disambiguateGeneratedMethodName(List<RecordClassType> recordCompo
}

private MethodSpec buildShimMethod(String name, TypeName mainType, Class<?> abstractType,
ParameterizedTypeName parameterizedType, TypeVariableName... typeVariables) {
CodeBlock code;
if (mainType.equals(setTypeName)) {
code = CodeBlock.of("return (o != null) ? $T.unmodifiableSet(($T) o) : $T.of()", collectionsTypeName, parameterizedType, mainType);
} else {
code = CodeBlock.of("return (o != null) ? $T.copyOf(o) : $T.of()", mainType, mainType);
}
ParameterizedTypeName parameterizedType, TypeVariableName... typeVariables) {
var code = buildShimMethodBody(mainType, parameterizedType);

TypeName[] wildCardTypeArguments = parameterizedType.typeArguments.stream().map(WildcardTypeName::subtypeOf)
.toList().toArray(new TypeName[0]);
Expand All @@ -315,8 +316,45 @@ private MethodSpec buildShimMethod(String name, TypeName mainType, Class<?> abst
.returns(parameterizedType).addParameter(extendedParameterizedType, "o").addStatement(code).build();
}

private CodeBlock buildShimMethodBody(TypeName mainType, ParameterizedTypeName parameterizedType) {
if (!useUnmodifiableCollections) {
return CodeBlock.of("return (o != null) ? $T.copyOf(o) : $T.of()", mainType, mainType);
}

if (mainType.equals(listTypeName)) {
return CodeBlock.of("return (o != null) ? $T.<$T>unmodifiableList(($T) o) : $T.<$T>emptyList()",
collectionsTypeName,
tType,
parameterizedType,
collectionsTypeName,
tType);
}

if (mainType.equals(setTypeName)) {
return CodeBlock.of("return (o != null) ? $T.<$T>unmodifiableSet(($T) o) : $T.<$T>emptySet()",
collectionsTypeName,
tType,
parameterizedType,
collectionsTypeName,
tType);
}

if (mainType.equals(mapTypeName)) {
return CodeBlock.of("return (o != null) ? $T.<$T, $T>unmodifiableMap(($T) o) : $T.<$T, $T>emptyMap()",
collectionsTypeName,
kType,
vType,
parameterizedType,
collectionsTypeName,
kType,
vType);
}

throw new IllegalStateException("Cannot build shim method for" + mainType);
}

private MethodSpec buildMutableMakerMethod(String name, String mutableCollectionType,
ParameterizedTypeName parameterizedType, TypeVariableName... typeVariables) {
ParameterizedTypeName parameterizedType, TypeVariableName... typeVariables) {
var nullCase = CodeBlock.of("if (o == null) return new $L<>()", mutableCollectionType);
var isMutableCase = CodeBlock.of("if (o instanceof $L) return o", mutableCollectionType);
var defaultCase = CodeBlock.of("return new $L<>(o)", mutableCollectionType);
Expand All @@ -327,7 +365,7 @@ private MethodSpec buildMutableMakerMethod(String name, String mutableCollection
}

private TypeSpec buildMutableCollectionSubType(String className, ClassName mutableCollectionType,
ParameterizedTypeName parameterizedType, TypeVariableName... typeVariables) {
ParameterizedTypeName parameterizedType, TypeVariableName... typeVariables) {
TypeName[] typeArguments = new TypeName[] {};
typeArguments = Arrays.stream(typeVariables).toList().toArray(typeArguments);

Expand All @@ -348,12 +386,28 @@ private TypeSpec buildMutableCollectionSubType(String className, ClassName mutab
}

private MethodSpec buildCollectionsShimMethod() {
var code = CodeBlock.builder().add("if (o instanceof Set) {\n").indent()
.addStatement("return $T.copyOf(o)", setTypeName).unindent().addStatement("}")
.addStatement("return (o != null) ? $T.copyOf(o) : $T.of()", listTypeName, listTypeName).build();
var code = buildCollectionShimMethodBody();
return MethodSpec.methodBuilder(collectionShimName).addAnnotation(generatedRecordBuilderAnnotation)
.addModifiers(Modifier.PRIVATE, Modifier.STATIC).addTypeVariable(tType)
.returns(parameterizedCollectionType).addParameter(parameterizedCollectionType, "o").addCode(code)
.build();
}

private CodeBlock buildCollectionShimMethodBody() {
if (!useUnmodifiableCollections) {
return CodeBlock.builder().add("if (o instanceof Set) {\n").indent()
.addStatement("return $T.copyOf(o)", setTypeName).unindent().addStatement("}")
.addStatement("return (o != null) ? $T.copyOf(o) : $T.of()", listTypeName, listTypeName).build();
}

return CodeBlock.builder()
.beginControlFlow("if (o instanceof $T)", listType)
.addStatement("return $T.<$T>unmodifiableList(($T) o)", collectionsTypeName, tType, parameterizedListType)
.endControlFlow()
.beginControlFlow("if (o instanceof $T)", setType)
.addStatement("return $T.<$T>unmodifiableSet(($T) o)", collectionsTypeName, tType, parameterizedSetType)
.endControlFlow()
.addStatement("return $T.<$T>emptyList()", collectionsTypeName, tType)
.build();
}
}
17 changes: 17 additions & 0 deletions ...er-processor/src/main/java/io/soabase/recordbuilder/processor/RecordBuilderProcessor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,9 @@ private void processRecordInterface(TypeElement element, boolean addRecordBuilde
"RecordInterface only valid for interfaces.", element);
return;
}

validateMetaData(metaData, element);

var internalProcessor = new InternalRecordInterfaceProcessor(processingEnv, element, addRecordBuilder, metaData,
packageName, fromTemplate);
if (!internalProcessor.isValid()) {
Expand All @@ -184,11 +187,25 @@ private void processRecordBuilder(TypeElement record, RecordBuilder.Options meta
record);
return;
}

validateMetaData(metaData, record);

var internalProcessor = new InternalRecordBuilderProcessor(processingEnv, record, metaData, packageName);
writeRecordBuilderJavaFile(record, internalProcessor.packageName(), internalProcessor.builderClassType(),
internalProcessor.builderType(), metaData);
}

private void validateMetaData(RecordBuilder.Options metaData, Element record) {
var useImmutableCollections = metaData.useImmutableCollections();
var useUnmodifiableCollections = metaData.useUnmodifiableCollections();

if (useImmutableCollections && useUnmodifiableCollections) {
processingEnv.getMessager().printMessage(Diagnostic.Kind.MANDATORY_WARNING,
"Options.useUnmodifiableCollections property is ignored as Options.useImmutableCollections is set to true",
record);
}
}

private void writeRecordBuilderJavaFile(TypeElement record, String packageName, ClassType builderClassType,
TypeSpec builderType, RecordBuilder.Options metaData) {
// produces the Java file
Expand Down
7 changes: 5 additions & 2 deletions .../recordbuilder/test/OrderedSetRecord.java → ...r/test/UnmodifiableCollectionsRecord.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,12 @@

import io.soabase.recordbuilder.core.RecordBuilder;

import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;

@RecordBuilder
@RecordBuilder.Options(useImmutableCollections = true)
record OrderedSetRecord(Set<String> orderedSet) {
@RecordBuilder.Options(useUnmodifiableCollections = true)
record UnmodifiableCollectionsRecord(List<Integer> aList, Set<String> orderedSet, Map<String, Integer> orderedMap, Collection<String> aCollection) {
}
40 changes: 0 additions & 40 deletions record-builder-test/src/test/java/io/soabase/recordbuilder/test/TestOrderedSetsBuilder.java
View file

This file was deleted.

Loading

0 comments on commit 5836199

Please sign in to comment.