org.openapitools.codegen.CodegenDiscriminator Maven / Gradle / Ivy
package org.openapitools.codegen;
import lombok.Getter;
import lombok.Setter;
import java.util.*;
/**
* This class encapsulates the OpenAPI discriminator construct, as specified at
* https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#discriminatorObject.
*
* When request bodies or response payloads may be one of a number of different schemas,
* a discriminator object can be used to aid in serialization, deserialization, and validation.
* The discriminator is a specific object in a schema which is used to inform the consumer of
* the specification of an alternative schema based on the value associated with it.
*/
public class CodegenDiscriminator {
// The name of the property in the payload that will hold the discriminator value.
// This is the propertyName as specified in the OpenAPI discriminator object.
@Getter @Setter
private String propertyName;
@Getter @Setter
private String propertyBaseName;
@Getter @Setter
private String propertyGetter;
@Getter @Setter
private String propertyType;
@Getter @Setter
private Map mapping;
private boolean isEnum;
// mappedModels is populated differently if legacyDiscriminatorBehavior is
// True or False. When:
//
// legacyDiscriminatorBehavior == False, this contains:
// - the name to schema map info in the discriminator mapping entry in your openapi spec OR
// - child schemas that allOf inherit self schema
//
// legacyDiscriminatorBehavior == True, this contains:
// - the name to schema map info in the discriminMappedModelator mapping entry in your openapi spec AND
// - x-discriminator-value mappings in child oneOf + anyOf schemas + descendant schemas that allOf inherit self schema AND
// - descendant schemas that allOf inherit self schema AND
// - child oneOf + anyOf schemas
//
// see the method createDiscriminator in DefaultCodegen.java
@Getter @Setter
private Set mappedModels = new TreeSet<>();
@Getter @Setter
private Map vendorExtensions = new HashMap<>();
public boolean getIsEnum() {
return isEnum;
}
public void setIsEnum(boolean isEnum) {
this.isEnum = isEnum;
}
/**
* An object to hold discriminator mappings between payload values and schema names or
* references.
*
* In the OpenAPI document, the discriminator "mapping" attribute is optional.
* In scenarios where the value of the discriminator field does not match the schema name
* or implicit mapping is not possible, an optional mapping definition MAY be used.
* In OpenAPITools codegen, the MappedModel is the union of all the discriminator mappings,
* both explicitly defined in the OpenAPI document and inherited from oneOf/allOf/anyOf.
*/
public static class MappedModel implements Comparable {
// The value of the discriminator property in the payload.
@Getter @Setter
private String mappingName;
// The OAS schema name. It is obtained from the OAS document, and the string value
// is converted to a sanitized, internal representation within codegen.
@Getter @Setter
private String modelName;
@Getter @Setter
private CodegenModel model;
private final boolean explicitMapping;
public MappedModel(String mappingName, String modelName, boolean explicitMapping) {
this.mappingName = mappingName;
this.modelName = modelName;
this.explicitMapping = explicitMapping;
}
public MappedModel(String mappingName, String modelName) {
this(mappingName, modelName, false);
}
@Override
public int compareTo(MappedModel other) {
if (getMappingName() == null && other.getMappingName() == null) {
return 0;
} else if (getMappingName() == null) {
return 1;
} else if (other.getMappingName() == null) {
return -1;
}
// prioritize mappings based on mappings in the spec before any auto-generated
// so that during serialization the proper values are used in the json
if (explicitMapping != other.explicitMapping) {
return explicitMapping ? -1 : 1;
} else {
return getMappingName().compareTo(other.getMappingName());
}
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
MappedModel that = (MappedModel) o;
return Objects.equals(mappingName, that.mappingName) &&
Objects.equals(modelName, that.modelName);
}
@Override
public int hashCode() {
return Objects.hash(mappingName, modelName);
}
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
CodegenDiscriminator that = (CodegenDiscriminator) o;
return Objects.equals(propertyName, that.propertyName) &&
Objects.equals(propertyBaseName, that.propertyBaseName) &&
Objects.equals(mapping, that.mapping) &&
Objects.equals(mappedModels, that.mappedModels) &&
Objects.equals(vendorExtensions, that.vendorExtensions);
}
@Override
public int hashCode() {
return Objects.hash(propertyName, propertyBaseName, mapping, mappedModels, vendorExtensions);
}
@Override
public String toString() {
final StringBuffer sb = new StringBuffer("CodegenDiscriminator{");
sb.append("propertyName='").append(propertyName).append('\'');
sb.append(", propertyBaseName='").append(propertyBaseName).append('\'');
sb.append(", mapping=").append(mapping);
sb.append(", mappedModels=").append(mappedModels);
sb.append(", vendorExtensions=").append(vendorExtensions);
sb.append('}');
return sb.toString();
}
}