com.github.fge.msgsimple.source.PropertiesMessageSource Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of msg-simple Show documentation
Show all versions of msg-simple Show documentation
Uploads all artifacts belonging to configuration ':archives'
/*
* Copyright (c) 2013, Francis Galiegue
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Lesser GNU 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
* Lesser GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see You can load property files from the classpath or from files on your
* filesystem. You can also specify the character set used to read the file;
* methods without a character set as an argument use UTF-8.
*
* @see Properties#load(Reader)
*/
public final class PropertiesMessageSource
implements MessageSource
{
private static final InternalBundle BUNDLE
= InternalBundle.getInstance();
private static final Charset UTF8 = Charset.forName("UTF-8");
private final Map messages = new HashMap();
/**
* Create a message source from a classpath resource using UTF-8
*
* @param resourcePath the path to the properties file
* @return a newly created source
* @throws NullPointerException resource path is null
* @throws IOException no such resource, or an I/O error occurred while
* reading the file
*/
public static MessageSource fromResource(final String resourcePath)
throws IOException
{
return fromResource(resourcePath, UTF8);
}
/**
* Create a message source from a classpath resource using the specified
* charset
*
* @since 0.5
*
* @param resourcePath the path to the properties file
* @param charset the character set to use
* @return a newly created source
* @throws NullPointerException resource path is null
* @throws IOException no such resource, or an I/O error occurred while
* reading the file
*/
public static MessageSource fromResource(final String resourcePath,
final Charset charset)
throws IOException
{
BUNDLE.checkNotNull(resourcePath, "cfg.nullResourcePath");
final URL url = PropertiesMessageSource.class.getResource(resourcePath);
if (url == null)
throw new IOException(
BUNDLE.printf("properties.resource.notFound", resourcePath));
final InputStream in = url.openStream();
try {
return fromInputStream(in, charset);
} finally {
closeQuietly(in);
}
}
/**
* Create a message source from a properties file on the filesystem using
* UTF-8
*
* @param file the file to read from
* @return a newly created message source
* @throws NullPointerException file is null
* @throws FileNotFoundException file does not exist, or cannot access file
* @throws IOException failed to read from file
*/
public static MessageSource fromFile(final File file)
throws IOException
{
return fromFile(file, UTF8);
}
/**
* Create a message source from a properties file on the filesystem using
* the specified encoding
*
* This essentially calls {@link #fromFile(File)}.
*
* @since 0.5
*
* @param path the file path
* @return a newly created message source
* @throws NullPointerException path is null
* @throws IOException see {@link #fromFile(File)}
*/
public static MessageSource fromPath(final String path)
throws IOException
{
BUNDLE.checkNotNull(path, "cfg.nullPath");
return fromFile(new File(path), UTF8);
}
/**
* Create a message source from a properties file on the filesystem using
* the specified charset
*
* @since 0.5
*
* @param file the file to read from
* @param charset the character set to use
* @return a newly created message source
* @throws NullPointerException file is null
* @throws FileNotFoundException file does not exist, or cannot access file
* @throws IOException failed to read from file
*/
public static MessageSource fromFile(final File file, final Charset charset)
throws IOException
{
BUNDLE.checkNotNull(file, "cfg.nullFile");
final FileInputStream in = new FileInputStream(file);
try {
return fromInputStream(in, charset);
} finally {
closeQuietly(in);
}
}
/**
* Create a message source from a properties file on the filesystem using
* the specified charset
*
* This essentially calls {@link #fromFile(File, Charset)}.
*
* @since 0.5
*
* @param path the file path
* @param charset the character set
* @return a newly created message source
* @throws NullPointerException path is null
* @throws IOException see {@link #fromFile(File)}
*/
public static MessageSource fromPath(final String path,
final Charset charset)
throws IOException
{
BUNDLE.checkNotNull(path, "cfg.nullPath");
return fromFile(new File(path), charset);
}
/*
* The method by which every static factory method of this class passes to
* load the actual properties file.
*
* It is the caller's responsibility to close the InputStream as an
* argument.
*/
private static MessageSource fromInputStream(final InputStream in,
final Charset charset)
throws IOException
{
// can it ever happen?
BUNDLE.checkNotNull(in, "cfg.nullInputStream");
final Reader reader = new InputStreamReader(in, charset);
try {
final Properties properties = new Properties();
// This method is available only since 1.6+
properties.load(reader);
return new PropertiesMessageSource(properties);
} finally {
closeQuietly(reader);
}
}
private PropertiesMessageSource(final Properties properties)
{
// I have yet to see an example for which the full keyset of a
// Properties object is not returned by keySet(), but...
for (final String key: properties.stringPropertyNames())
messages.put(key, properties.getProperty(key));
}
@Override
public String getKey(final String key)
{
return messages.get(key);
}
private static void closeQuietly(final Closeable closeable)
{
try {
closeable.close();
} catch (IOException ignored) {
}
}
}