LocalizationMapReader.java

package com.freya02.botcommands.api.localization.readers;

import com.freya02.botcommands.api.core.config.BServiceConfigBuilder;
import com.freya02.botcommands.api.core.service.annotations.BService;
import com.freya02.botcommands.api.core.service.annotations.InterfacedService;
import com.freya02.botcommands.api.localization.LocalizationMap;
import com.freya02.botcommands.api.localization.LocalizationMapRequest;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.io.IOException;

/**
 * Reads localization mappings
 *
 * <p>
 * <b>Usage</b>: Register your instance as a service with {@link BService}
 * or {@link BServiceConfigBuilder#getServiceAnnotations() any annotation that enables your class for dependency injection}.
 */
@InterfacedService(acceptMultiple = true)
public interface LocalizationMapReader {
    /**
     * Utility method to append a path component to an existing path, this is simply {@code path + '.' + other}.
     *
     * @param path  The current path
     * @param other The other path component
     *
     * @return The new path
     */
    default String appendPath(String path, String other) {
        if (path.isBlank()) return other;

        return path + '.' + other;
    }

    /**
     * Reads a {@link LocalizationMap} from the requested bundle, returns {@code null} if no localization map exists.
     *
     * <p>This should not read parent bundles, only this specific one.
     */
    @Nullable
    LocalizationMap readLocalizationMap(@NotNull LocalizationMapRequest request) throws IOException;
}