com.gitee.starblues.loader.classloader.resource.loader.ResourceLoaderFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spring-brick-loader Show documentation

加载插件模块

There is a newer version: 3.1.2

/**
 * Copyright [2019-Present] [starBlues]
 *
 * 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 com.gitee.starblues.loader.classloader.resource.loader;

import com.gitee.starblues.loader.classloader.resource.Resource;
import com.gitee.starblues.loader.utils.Release;

import java.io.File;
import java.io.InputStream;
import java.net.URL;
import java.nio.file.Path;
import java.util.Enumeration;
import java.util.List;

/**
 * 资源加载工厂
 *
 * @author starBlues
 * @since 3.0.0
 * @version 3.1.1
 */
public interface ResourceLoaderFactory extends AutoCloseable, Release {

    /**
     * 根据路径字符串添加资源
     * @param path 路径字符串
     * @throws Exception 添加资源异常
     */
    void addResource(String path) throws Exception;

    /**
     * 根据文件添加资源
     * @param file 文件
     * @throws Exception 添加资源异常
     */
    void addResource(File file) throws Exception;

    /**
     * 根据路径添加资源
     * @param path 路径
     * @throws Exception 添加资源异常
     */
    void addResource(Path path) throws Exception;

    /**
     * 根据 URL 添加资源
     * @param url URL
     * @throws Exception 添加资源异常
     */
    void addResource(URL url) throws Exception;

    /**
     * 根据 Resource 添加
     * @param resource 资源
     * @throws Exception 添加资源异常
     */
    void addResource(Resource resource) throws Exception;

    /**
     * 根据资源加载器添加资源
     * @param resourceLoader 资源加载者
     * @throws Exception 添加资源异常
     */
    void addResource(ResourceLoader resourceLoader) throws Exception;

    /**
     * 根据资源名称获取第一个资源
     * @param name 资源名称
     * @return Resource
     */
    Resource findFirstResource(String name);

    /**
     * 根据资源名称获取资源集合
     * @param name 资源名称
     * @return Resource
     */
    Enumeration findAllResource(String name);

    /**
     * 根据资源名称获取第一个资源的 InputStream
     * @param name 资源名称
     * @return Resource
     */
    InputStream getInputStream(String name);

    /**
     * 获取所有URL
     * @return URL
     */
    List getUrls();


}