Skip to content

Commit

Permalink
http-client-java, unify branded/unbranded ExpandableEnum (#5334)
Browse files Browse the repository at this point in the history 
### Issue
- Last item of Azure/autorest.java#2841
- Previous unbranded implementation has two major issues
  - No `equals()` override
  - Non-string implementation can't compile

### This PR
- Apply current branded ExpandableEnum interface implementation to
unbranded
- `fromString` will be unified as `fromValue`, and will throw if
parameter is null(previously will return null)

### Test
Tested with openai, no compilation issue found:
```java// Code generated by Microsoft (R) TypeSpec Code Generator.

package com.openai;

import io.clientcore.core.annotation.Metadata;
import io.clientcore.core.util.ExpandableEnum;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Map;
import java.util.Objects;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.Function;

/**
 * Defines values for OlympicRecordModel.
 */
public final class OlympicRecordModel implements ExpandableEnum<Double> {
    private static final Map<Double, OlympicRecordModel> VALUES = new ConcurrentHashMap<>();

    private static final Function<Double, OlympicRecordModel> NEW_INSTANCE = OlympicRecordModel::new;

    /**
     * Static value 9.58 for OlympicRecordModel.
     */
    @metadata(generated = true)
    public static final OlympicRecordModel OLYMPIC_100_METERS = fromValue(9.58);

    /**
     * Static value 19.3 for OlympicRecordModel.
     */
    @metadata(generated = true)
    public static final OlympicRecordModel OLYMPIC_200_METERS = fromValue(19.3);

    private final Double value;

    private OlympicRecordModel(Double value) {
        this.value = value;
    }

    /**
     * Creates or finds a OlympicRecordModel.
     * 
     * @param value a value to look for.
     * @return the corresponding OlympicRecordModel.
     * @throws IllegalArgumentException if value is null.
     */
    @metadata(generated = true)
    public static OlympicRecordModel fromValue(Double value) {
        if (value == null) {
            throw new IllegalArgumentException("'value' cannot be null.");
        }
        return VALUES.computeIfAbsent(value, NEW_INSTANCE);
    }

    /**
     * Gets known OlympicRecordModel values.
     * 
     * @return Known OlympicRecordModel values.
     */
    @metadata(generated = true)
    public static Collection<OlympicRecordModel> values() {
        return new ArrayList<>(VALUES.values());
    }

    /**
     * Gets the value of the OlympicRecordModel instance.
     * 
     * @return the value of the OlympicRecordModel instance.
     */
    @metadata(generated = true)
    @OverRide
    public Double getValue() {
        return this.value;
    }

    @metadata(generated = true)
    @OverRide
    public String toString() {
        return Objects.toString(this.value);
    }

    @metadata(generated = true)
    @OverRide
    public boolean equals(Object obj) {
        return this == obj;
    }

    @metadata(generated = true)
    @OverRide
    public int hashCode() {
        return Objects.hashCode(this.value);
    }
}

```
  • Loading branch information
@XiaofeiCao
XiaofeiCao authored Dec 12, 2024
1 parent 093e986 commit df5a885
Show file tree
Hide file tree
Showing 7 changed files with 125 additions and 185 deletions.
6 changes: 5 additions & 1 deletion .../src/main/java/com/microsoft/typespec/http/client/generator/core/mapper/ChoiceMapper.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
package com.microsoft.typespec.http.client.generator.core.mapper;

import com.microsoft.typespec.http.client.generator.core.extension.model.codemodel.ChoiceSchema;
import com.microsoft.typespec.http.client.generator.core.extension.plugin.JavaSettings;
import com.microsoft.typespec.http.client.generator.core.model.clientmodel.ClassType;
import com.microsoft.typespec.http.client.generator.core.model.clientmodel.EnumType;
import com.microsoft.typespec.http.client.generator.core.model.clientmodel.IType;
Expand Down Expand Up @@ -53,9 +54,12 @@ protected boolean useCodeModelNameForEnumMember() {
private IType createChoiceType(ChoiceSchema enumType) {
IType elementType = Mappers.getSchemaMapper().map(enumType.getChoiceType());
boolean isStringEnum = elementType == ClassType.STRING;
if (isStringEnum) {
JavaSettings javaSettings = JavaSettings.getInstance();
if (isStringEnum && javaSettings.isBranded()) {
// for branded string enum, will generate ExpandableStringEnum subclass
return MapperUtils.createEnumType(enumType, true, useCodeModelNameForEnumMember());
} else {
// other cases, will generate ExpandableEnum interface implementation
return MapperUtils.createEnumType(enumType, true, useCodeModelNameForEnumMember(), "getValue", "fromValue");
}
}
Expand Down
1 change: 1 addition & 0 deletions ...n/java/com/microsoft/typespec/http/client/generator/core/model/clientmodel/ClassType.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ public String getGenericClass() {
put(SimpleResponse.class, new ClassDetails(SimpleResponse.class, "io.clientcore.core.http.SimpleResponse"));
put(ExpandableStringEnum.class,
new ClassDetails(ExpandableStringEnum.class, "io.clientcore.core.util.ExpandableEnum"));
put(ExpandableEnum.class, new ClassDetails(ExpandableEnum.class, "io.clientcore.core.util.ExpandableEnum"));
put(HttpResponseException.class, new ClassDetails(HttpResponseException.class,
"io.clientcore.core.http.exception.HttpResponseException"));
put(HttpTrait.class, new ClassDetails(HttpTrait.class, "io.clientcore.core.models.traits.HttpTrait"));
Expand Down
3 changes: 1 addition & 2 deletions ...in/java/com/microsoft/typespec/http/client/generator/core/model/clientmodel/EnumType.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,7 @@ public final String defaultValueExpression(String sourceExpression) {
return getName() + "." + enumValue.getName();
}
}
return String.format("%1$s.from%2$s(%3$s)", getName(),
CodeNamer.toPascalCase(this.getElementType().toString()),
return String.format("%1$s.%2$s(%3$s)", getName(), getFromMethodName(),
this.getElementType().defaultValueExpression(sourceExpression));
} else {
for (ClientEnumValue enumValue : this.getValues()) {
Expand Down
285 changes: 106 additions & 179 deletions ...rc/main/java/com/microsoft/typespec/http/client/generator/core/template/EnumTemplate.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public final void write(EnumType enumType, JavaFile javaFile) {
if (settings.isBranded()) {
writeBrandedExpandableEnum(enumType, javaFile, settings);
} else {
writeExpandableStringEnumInterface(enumType, javaFile, settings);
writeExpandableEnumInterface(enumType, javaFile, settings);
}
} else {
writeEnum(enumType, javaFile, settings);
Expand All @@ -59,185 +59,8 @@ protected void writeBrandedExpandableEnum(EnumType enumType, JavaFile javaFile,
if (enumType.getElementType() == ClassType.STRING) {
writeExpandableStringEnum(enumType, javaFile, settings);
} else {
Set<String> imports = new HashSet<>();
imports.add("java.util.Collection");
imports.add("java.lang.IllegalArgumentException");
imports.add("java.util.Map");
imports.add("java.util.concurrent.ConcurrentHashMap");
imports.add("java.util.ArrayList");
imports.add("java.util.Objects");
imports.add(ClassType.EXPANDABLE_ENUM.getFullName());
imports.add("java.util.function.Function");
if (!settings.isStreamStyleSerialization()) {
imports.add("com.fasterxml.jackson.annotation.JsonCreator");
}

addGeneratedImport(imports);

javaFile.declareImport(imports);
javaFile.javadocComment(comment -> comment.description(enumType.getDescription()));

String enumName = enumType.getName();
IType elementType = enumType.getElementType();
String typeName = elementType.getClientType().asNullable().toString();
String pascalTypeName = CodeNamer.toPascalCase(typeName);
String declaration = enumName + " implements ExpandableEnum<" + pascalTypeName + ">";
javaFile.publicFinalClass(declaration, classBlock -> {
classBlock.privateStaticFinalVariable(
String.format("Map<%1$s, %2$s> VALUES = new ConcurrentHashMap<>()", pascalTypeName, enumName));
classBlock.privateStaticFinalVariable(
String.format("Function<%1$s, %2$s> NEW_INSTANCE = %2$s::new", pascalTypeName, enumName));

for (ClientEnumValue enumValue : enumType.getValues()) {
String value = enumValue.getValue();
classBlock.javadocComment(CoreUtils.isNullOrEmpty(enumValue.getDescription())
? "Static value " + value + " for " + enumName + "."
: enumValue.getDescription());
addGeneratedAnnotation(classBlock);
classBlock.publicStaticFinalVariable(String.format("%1$s %2$s = fromValue(%3$s)", enumName,
enumValue.getName(), elementType.defaultValueExpression(value)));
}

classBlock.variable(pascalTypeName + " value", JavaVisibility.Private, JavaModifier.Final);
classBlock.privateConstructor(enumName + "(" + pascalTypeName + " value)", ctor -> {
ctor.line("this.value = value;");
});

// fromValue(typeName)
classBlock.javadocComment(comment -> {
comment.description("Creates or finds a " + enumName);
comment.param("value", "a value to look for");
comment.methodReturns("the corresponding " + enumName);
});

addGeneratedAnnotation(classBlock);
if (!settings.isStreamStyleSerialization()) {
classBlock.annotation("JsonCreator");
}

classBlock.publicStaticMethod(String.format("%1$s fromValue(%2$s value)", enumName, pascalTypeName),
function -> {
function.line("Objects.requireNonNull(value, \"'value' cannot be null.\");");
function.methodReturn("VALUES.computeIfAbsent(value, NEW_INSTANCE)");
});

// values
classBlock.javadocComment(comment -> {
comment.description("Gets known " + enumName + " values.");
comment.methodReturns("Known " + enumName + " values.");
});
addGeneratedAnnotation(classBlock);
classBlock.publicStaticMethod(String.format("Collection<%s> values()", enumName),
function -> function.methodReturn("new ArrayList<>(VALUES.values())"));

// getValue
classBlock.javadocComment(comment -> {
comment.description("Gets the value of the " + enumName + " instance.");
comment.methodReturns("the value of the " + enumName + " instance.");
});

addGeneratedAnnotation(classBlock);
classBlock.annotation("Override");
classBlock.publicMethod(pascalTypeName + " getValue()",
function -> function.methodReturn("this.value"));

// toString
addGeneratedAnnotation(classBlock);
classBlock.annotation("Override");
classBlock.method(JavaVisibility.Public, null, "String toString()",
function -> function.methodReturn("Objects.toString(this.value)"));

// equals
addGeneratedAnnotation(classBlock);
classBlock.annotation("Override");
classBlock.method(JavaVisibility.Public, null, "boolean equals(Object obj)",
function -> function.methodReturn("this == obj"));

// hashcode
addGeneratedAnnotation(classBlock);
classBlock.annotation("Override");
classBlock.method(JavaVisibility.Public, null, "int hashCode()",
function -> function.methodReturn("Objects.hashCode(this.value)"));
});
}
}

private void writeExpandableStringEnumInterface(EnumType enumType, JavaFile javaFile, JavaSettings settings) {
Set<String> imports = new HashSet<>();
imports.add("java.util.Collection");
imports.add("java.util.concurrent.ConcurrentHashMap");
imports.add("java.util.Map");
imports.add(getStringEnumImport());
if (!settings.isStreamStyleSerialization()) {
imports.add("com.fasterxml.jackson.annotation.JsonCreator");
writeExpandableEnumInterface(enumType, javaFile, settings);
}

addGeneratedImport(imports);

javaFile.declareImport(imports);
javaFile.javadocComment(comment -> comment.description(enumType.getDescription()));

String enumName = enumType.getName();
IType elementType = enumType.getElementType();
String typeName = elementType.getClientType().toString();
String pascalTypeName = CodeNamer.toPascalCase(typeName);
String declaration = enumName + " implements ExpandableEnum<" + pascalTypeName + ">";

javaFile.publicFinalClass(declaration, classBlock -> {
classBlock.privateStaticFinalVariable("Map<String, " + enumName + "> VALUES = new ConcurrentHashMap<>()");

for (ClientEnumValue enumValue : enumType.getValues()) {
String value = enumValue.getValue();
classBlock.javadocComment(CoreUtils.isNullOrEmpty(enumValue.getDescription())
? "Static value " + value + " for " + enumName + "."
: enumValue.getDescription());
addGeneratedAnnotation(classBlock);
classBlock.publicStaticFinalVariable(String.format("%1$s %2$s = from%3$s(%4$s)", enumName,
enumValue.getName(), pascalTypeName, elementType.defaultValueExpression(value)));
}

classBlock.variable("String name", JavaVisibility.Private, JavaModifier.Final);
classBlock.privateConstructor(enumName + "(String name)", ctor -> {
ctor.line("this.name = name;");
});

// fromString(typeName)
classBlock.javadocComment(comment -> {
comment.description("Creates or finds a " + enumName);
comment.param("name", "a name to look for");
comment.methodReturns("the corresponding " + enumName);
});

addGeneratedAnnotation(classBlock);
if (!settings.isStreamStyleSerialization()) {
classBlock.annotation("JsonCreator");
}

classBlock.publicStaticMethod(String.format("%1$s from%2$s(%3$s name)", enumName, pascalTypeName, typeName),
function -> {
function.ifBlock("name == null", ifAction -> ifAction.methodReturn("null"));
function.line(enumName + " value = VALUES.get(name);");
function.ifBlock("value != null", ifAction -> {
ifAction.line("return value;");
});
function.methodReturn("VALUES.computeIfAbsent(name, key -> new " + enumName + "(key))");
});

// getValue
classBlock.javadocComment(comment -> {
comment.description("Gets the value of the " + enumName + " instance.");
comment.methodReturns("the value of the " + enumName + " instance.");
});

addGeneratedAnnotation(classBlock);
classBlock.annotation("Override");
classBlock.publicMethod(pascalTypeName + " getValue()", function -> function.methodReturn("this.name"));

addGeneratedAnnotation(classBlock);
classBlock.annotation("Override");
classBlock.method(JavaVisibility.Public, null, "String toString()",
function -> function.methodReturn("name"));
});
}

private void writeExpandableStringEnum(EnumType enumType, JavaFile javaFile, JavaSettings settings) {
Expand Down Expand Up @@ -385,6 +208,110 @@ private void writeEnum(EnumType enumType, JavaFile javaFile, JavaSettings settin
});
}

private void writeExpandableEnumInterface(EnumType enumType, JavaFile javaFile, JavaSettings settings) {
Set<String> imports = new HashSet<>();
imports.add("java.util.Collection");
imports.add("java.lang.IllegalArgumentException");
imports.add("java.util.Map");
imports.add("java.util.concurrent.ConcurrentHashMap");
imports.add("java.util.ArrayList");
imports.add("java.util.Objects");
imports.add(ClassType.EXPANDABLE_ENUM.getFullName());
imports.add("java.util.function.Function");
if (!settings.isStreamStyleSerialization()) {
imports.add("com.fasterxml.jackson.annotation.JsonCreator");
}

addGeneratedImport(imports);

javaFile.declareImport(imports);
javaFile.javadocComment(comment -> comment.description(enumType.getDescription()));

String enumName = enumType.getName();
IType elementType = enumType.getElementType();
String typeName = elementType.getClientType().asNullable().toString();
String pascalTypeName = CodeNamer.toPascalCase(typeName);
String declaration = enumName + " implements ExpandableEnum<" + pascalTypeName + ">";
javaFile.publicFinalClass(declaration, classBlock -> {
classBlock.privateStaticFinalVariable(
String.format("Map<%1$s, %2$s> VALUES = new ConcurrentHashMap<>()", pascalTypeName, enumName));
classBlock.privateStaticFinalVariable(
String.format("Function<%1$s, %2$s> NEW_INSTANCE = %2$s::new", pascalTypeName, enumName));

for (ClientEnumValue enumValue : enumType.getValues()) {
String value = enumValue.getValue();
classBlock.javadocComment(CoreUtils.isNullOrEmpty(enumValue.getDescription())
? "Static value " + value + " for " + enumName + "."
: enumValue.getDescription());
addGeneratedAnnotation(classBlock);
classBlock.publicStaticFinalVariable(String.format("%1$s %2$s = fromValue(%3$s)", enumName,
enumValue.getName(), elementType.defaultValueExpression(value)));
}

classBlock.variable(pascalTypeName + " value", JavaVisibility.Private, JavaModifier.Final);
classBlock.privateConstructor(enumName + "(" + pascalTypeName + " value)", ctor -> {
ctor.line("this.value = value;");
});

// fromValue(typeName)
classBlock.javadocComment(comment -> {
comment.description("Creates or finds a " + enumName);
comment.param("value", "a value to look for");
comment.methodReturns("the corresponding " + enumName);
comment.methodThrows("IllegalArgumentException", "if value is null");
});

addGeneratedAnnotation(classBlock);
if (!settings.isStreamStyleSerialization()) {
classBlock.annotation("JsonCreator");
}

classBlock.publicStaticMethod(String.format("%1$s fromValue(%2$s value)", enumName, pascalTypeName),
function -> {
function.ifBlock("value == null",
ifBlock -> ifBlock.line("throw new IllegalArgumentException(\"'value' cannot be null.\");"));
function.methodReturn("VALUES.computeIfAbsent(value, NEW_INSTANCE)");
});

// values
classBlock.javadocComment(comment -> {
comment.description("Gets known " + enumName + " values.");
comment.methodReturns("Known " + enumName + " values.");
});
addGeneratedAnnotation(classBlock);
classBlock.publicStaticMethod(String.format("Collection<%s> values()", enumName),
function -> function.methodReturn("new ArrayList<>(VALUES.values())"));

// getValue
classBlock.javadocComment(comment -> {
comment.description("Gets the value of the " + enumName + " instance.");
comment.methodReturns("the value of the " + enumName + " instance.");
});

addGeneratedAnnotation(classBlock);
classBlock.annotation("Override");
classBlock.publicMethod(pascalTypeName + " getValue()", function -> function.methodReturn("this.value"));

// toString
addGeneratedAnnotation(classBlock);
classBlock.annotation("Override");
classBlock.method(JavaVisibility.Public, null, "String toString()",
function -> function.methodReturn("Objects.toString(this.value)"));

// equals
addGeneratedAnnotation(classBlock);
classBlock.annotation("Override");
classBlock.method(JavaVisibility.Public, null, "boolean equals(Object obj)",
function -> function.methodReturn("this == obj"));

// hashcode
addGeneratedAnnotation(classBlock);
classBlock.annotation("Override");
classBlock.method(JavaVisibility.Public, null, "int hashCode()",
function -> function.methodReturn("Objects.hashCode(this.value)"));
});
}

protected String getStringEnumImport() {
return ClassType.EXPANDABLE_STRING_ENUM.getFullName();
}
Expand Down
5 changes: 4 additions & 1 deletion ...client-generator-test/src/main/java/tsptest/armresourceprovider/models/PriorityModel.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,13 @@ private PriorityModel(Integer value) {
*
* @param value a value to look for.
* @return the corresponding PriorityModel.
* @throws IllegalArgumentException if value is null.
*/
@JsonCreator
public static PriorityModel fromValue(Integer value) {
Objects.requireNonNull(value, "'value' cannot be null.");
if (value == null) {
throw new IllegalArgumentException("'value' cannot be null.");
}
return VALUES.computeIfAbsent(value, NEW_INSTANCE);
}

Expand Down
5 changes: 4 additions & 1 deletion ...tp-client-generator-test/src/main/java/tsptest/enumservice/models/OlympicRecordModel.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,13 @@ private OlympicRecordModel(Double value) {
*
* @param value a value to look for.
* @return the corresponding OlympicRecordModel.
* @throws IllegalArgumentException if value is null.
*/
@Generated
public static OlympicRecordModel fromValue(Double value) {
Objects.requireNonNull(value, "'value' cannot be null.");
if (value == null) {
throw new IllegalArgumentException("'value' cannot be null.");
}
return VALUES.computeIfAbsent(value, NEW_INSTANCE);
}

Expand Down
5 changes: 4 additions & 1 deletion ...or/http-client-generator-test/src/main/java/tsptest/enumservice/models/PriorityModel.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,13 @@ private PriorityModel(Integer value) {
*
* @param value a value to look for.
* @return the corresponding PriorityModel.
* @throws IllegalArgumentException if value is null.
*/
@Generated
public static PriorityModel fromValue(Integer value) {
Objects.requireNonNull(value, "'value' cannot be null.");
if (value == null) {
throw new IllegalArgumentException("'value' cannot be null.");
}
return VALUES.computeIfAbsent(value, NEW_INSTANCE);
}

Expand Down

0 comments on commit df5a885

Please sign in to comment.