xdev.util.res.ResourceSearchStrategy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xapi Show documentation

XDEV Application Framework

There is a newer version: 6.0.2

package xdev.util.res;

/*-
 * #%L
 * XDEV Application Framework
 * %%
 * Copyright (C) 2003 - 2020 XDEV Software
 * %%
 * This program 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.
 * 
 * This program 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 Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */


import java.util.*;


/**
 * A ResourceSearchStrategy is the way how resources are searched through the
 * class hierarchy or the file system.
 * 
 * @author XDEV Software
 * 
 * @since 2.0
 * 
 */

public interface ResourceSearchStrategy
{
	/**
	 * Searches for a resource entry according to key.

	 * The requestor may be crucial how the strategy is looking for
	 * the ressource.

	 * 

	 * If requestor is null only the default resource
	 * bundle is searched through.
	 * 
	 * @param key
	 *            the key of the resource's value pair
	 * @param locale
	 *            to lookup the String for
	 * @param requestor
	 *            the origin of the call to this method or null
	 * @return the value mapped to key
	 * @throws MissingResourceException
	 *             if no resource bundle can be found - depending on this search
	 *             strategy - or if the key can not be found in one of the
	 *             resource files
	 * @throws NullPointerException
	 *             if key is null
	 */
	
	public String lookupResourceString(String key, Locale locale, Object requestor)
			throws MissingResourceException, NullPointerException;
}