com.github.fabienbarbero.flickr.api.FlickrProperties Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flickr-api Show documentation
A Java library to access Flickr API (works with Android too!)
There is a newer version: 1.2
/*
 * (C) Copyright 2014 Fabien Barbero.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the GNU Lesser General Public License
 * (LGPL) version 2.1 which accompanies this distribution, and is available at
 * http://www.gnu.org/licenses/lgpl-2.1.html
 *
 * This library 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
 * Lesser General Public License for more details.
 */
package com.github.fabienbarbero.flickr.api;

import com.github.fabienbarbero.flickr.api.utils.IOUtils;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.Properties;

/**
 * This class handle the configuration read and storage.
 *
 * @author Fabien Barbero
 */
public abstract class FlickrProperties
{

    private final Properties props;

    public FlickrProperties()
    {
        this.props = new Properties();
    }

    final boolean contains( String key )
    {
        return props.containsKey( key );
    }

    final String getString( String key, String def )
    {
        return props.getProperty( key, def );
    }

    final void putString( String key, String value )
    {
        props.setProperty( key, value );
    }

    final void remove( String key )
    {
        props.remove( key );
    }

    final void load()
    {
        if ( isConfigExists() ) {
            InputStream is = null;
            try {
                is = getInputStream();
                props.load( is );

            } catch ( IOException ex ) {
                throw new UnsupportedOperationException( "Error reading flickr properties", ex );
            } finally {
                IOUtils.closeQuietly( is );
            }
        }
    }

    final void commit()
    {
        OutputStream os = null;
        try {
            os = getOutputStream();
            props.store( os, "Flickr configuration" );

        } catch ( IOException ex ) {
            throw new UnsupportedOperationException( "Error saving configuration", ex );
        } finally {
            IOUtils.closeQuietly( os );
        }
    }

    /**
     * Indicates if the configuration has already been defined
     *
     * @return true if the configuration has already been defined
     */
    protected abstract boolean isConfigExists();

    /**
     * Open an InputStream to read the configuration
     *
     * @return The stream
     * @throws IOException Error opening the stream
     */
    protected abstract InputStream getInputStream()
            throws IOException;

    /**
     * Open an OutputStream to write the configuration
     *
     * @return The stream
     * @throws IOException Error opening the stream
     */
    protected abstract OutputStream getOutputStream()
            throws IOException;

}