com.anrisoftware.resources.images.api.ImagesFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of resources-images Show documentation

Image resources.

There is a newer version: 4.7.0

/*
 * Copyright 2012-2016 Erwin Müller 
 *
 * This file is part of resources-images.
 *
 * resources-images is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * resources-images is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with resources-images. If not, see .
 */
package com.anrisoftware.resources.images.api;

import java.util.ResourceBundle;

/**
 * Factory to create a new images resources with the specified resource bundle
 * base name and optional class loader and resource bundle control.
 * 
 * @author Erwin Mueller, [email protected]
 * @since 1.1
 * @see Images
 */
public interface ImagesFactory {

	/**
	 * Creates a new {@link Images} with the resource bundle base name and the
	 * caller's class loader.
	 * 
	 * @param baseName
	 *            the base name {@link String}.
	 */
	Images create(String baseName);

	/**
	 * Creates a new {@link Images} with the resource bundle base name and the
	 * class loader.
	 * 
	 * @param baseName
	 *            the base name {@link String}.
	 * 
	 * @param classLoader
	 *            the {@link ClassLoader}.
	 */
	Images create(String baseName, ClassLoader classLoader);

	/**
	 * Creates a new {@link Images} with the resource bundle base name and the
	 * control.
	 * 
	 * @param baseName
	 *            the base name {@link String}.
	 * 
	 * @param control
	 *            the {@link ResourceBundle.Control}.
	 */
	Images create(String baseName, ResourceBundle.Control control);

	/**
	 * Creates a new {@link Images} with the resource bundle base name, the
	 * class loader and the control.
	 * 
	 * @param baseName
	 *            the base name {@link String}.
	 * 
	 * @param classLoader
	 *            the {@link ClassLoader}.
	 * 
	 * @param control
	 *            the {@link ResourceBundle.Control}.
	 */
	Images create(String baseName, ClassLoader classLoader,
			ResourceBundle.Control control);

}