Class PagedModelScanUtils.DetectedPagedModel

  • Enclosing class:
    PagedModelScanUtils

    public static final class PagedModelScanUtils.DetectedPagedModel
    extends Object
    Carries the result of a single detected paged-model schema.

    Two name variants are stored for each schema:

    • transformed (schemaName / metaSchemaName) — the model name after the generator's toModelName() has been applied. These are the names that appear in codegen-operation imports and CodegenModel.imports, so they must be used for import removal / import-presence checks.
    • raw (rawSchemaName / rawMetaSchemaName) — the original OpenAPI component-schema name. DefaultGenerator keys allProcessedModels (the objs map passed to postProcessAllModels) by the raw schema name, so these values must be used for objs.remove() calls.

    When PagedModelScanUtils.scanPagedModels(OpenAPI) is used (no transform), the raw and transformed names are identical. When PagedModelScanUtils.scanPagedModels(OpenAPI, UnaryOperator) is used, they may differ (e.g. rawSchemaName="UserPage", schemaName="UserPageDto").

    • Field Detail

      • schemaName

        public final String schemaName
        Transformed model name — use for import removal / import-presence checks.
      • itemSchemaName

        public final String itemSchemaName
      • metaSchemaName

        public final String metaSchemaName
        Transformed meta model name — use for import-presence checks.
      • rawSchemaName

        public final String rawSchemaName
        Raw OpenAPI schema name — use for objs.remove() in postProcessAllModels.
      • rawMetaSchemaName

        public final String rawMetaSchemaName
        Raw OpenAPI meta schema name — use for objs.remove() in postProcessAllModels.
    • Constructor Detail

      • DetectedPagedModel

        public DetectedPagedModel​(String schemaName,
                                  String itemSchemaName,
                                  String metaSchemaName)
        Convenience constructor used when no name transform is active (raw == transformed).