BotCommands/io.github.freya022.botcommands.api.localization.readers/AbstractJacksonLocalizationMapReader

AbstractJacksonLocalizationMapReader

abstract class AbstractJacksonLocalizationMapReader(objectMapper: ObjectMapper, templateFunction: LocalizationTemplateFunction) : LocalizationMapReader(source)

Helps to create a LocalizationMapReader based on an ObjectMapper.

You may supply a LocalizationTemplateFunction to customize the templates being filled, if the default provider is not enough.

Note: For most cases, using JacksonLocalizationMapReader is more than enough.

Example - YAML reader

You must add the jackson-dataformat-yaml dependency, make sure to match the version that JDA uses to avoid incompatibilities.

Kotlin

class YamlLocalizationMapReader(
    localizationTemplateFunction: LocalizationTemplateFunction,
    private val folderName: String,
) : AbstractJacksonLocalizationMapReader(
    ObjectMapper(YAMLFactory()), // Give it a YAMLFactory instead of the default JSONFactory
    localizationTemplateFunction,
) {

    override fun getInputStream(request: LocalizationMapRequest): InputStream? {
        return this.javaClass.getResourceAsStream("/$folderName/${request.bundleName}.yml")
            ?: this.javaClass.getResourceAsStream("/$folderName/${request.bundleName}.yaml")
    }
}

Java

public class YamlLocalizationMapReader extends AbstractJacksonLocalizationMapReader {

    private final String folderName;

    public YamlLocalizationMapReader(@NotNull LocalizationTemplateFunction templateFunction, @NotNull String folderName) {
        super(new ObjectMapper(new YAMLFactory()), templateFunction);
        this.folderName = folderName;
    }

    @Nullable
    @Override
    public InputStream getInputStream(@NotNull LocalizationMapRequest request) {
        final InputStream stream = getClass().getResourceAsStream("/%s/%s.yml".formatted(folderName, request.bundleName()));
        if (stream != null) return stream;

        return getClass().getResourceAsStream("/%s/%s.yaml".formatted(folderName, request.bundleName()));
    }
}