colesico.framework.resource.ResourceKit Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of colesico-resource Show documentation

Colesico framework resource services provides ability of resource rewriting and localization

There is a newer version: 5.3.0

/*
 * Copyright 20014-2018 Vladlen Larionov
 *             and others as noted
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
package colesico.framework.resource;

import java.io.InputStream;
import java.net.URL;
import java.util.Enumeration;

/**
 * Service for reading application resources
 *
 * @author Vladlen Larionov
 */
public interface ResourceKit {

    /**
     * Returns rewritten resource path if the rewriting was defined via config.
     * It is possible to overwrite the path by a partial prefix match.
     * E.g for the rewriting  '/etc/srv'->'/foo'   path '/etc/srv/generator/x' will be rewritten to '/foo/generator/x'
     *
     * @return
     * @see ResourceConfig
     */
    String rewrite(String resourcePath);

    /**
     * Rewrite path according to qualifiers and current locale
     */
    String localize(String resourcePath, L10NMode mode);

    String localize(String resourcePath, L10NMode mode, String[] qualfiers);

    String evaluate(String resourcePath);

    Enumeration getURLs(String resourcePath);

    InputStream getStream(String resourcePath);


    enum L10NMode {
        NONE, FILE, DIR
    }

}