001/*
002 * Copyright (c) 2003-2010 The Regents of the University of California.
003 * All rights reserved.
004 *
005 * '$Author: welker $'
006 * '$Date: 2010-05-06 05:21:26 +0000 (Thu, 06 May 2010) $' 
007 * '$Revision: 24234 $'
008 * 
009 * Permission is hereby granted, without written agreement and without
010 * license or royalty fees, to use, copy, modify, and distribute this
011 * software and its documentation for any purpose, provided that the above
012 * copyright notice and the following two paragraphs appear in all copies
013 * of this software.
014 *
015 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
016 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
017 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
018 * THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
019 * SUCH DAMAGE.
020 *
021 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
022 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
023 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
024 * PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
025 * CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
026 * ENHANCEMENTS, OR MODIFICATIONS.
027 *
028 */
029
030package org.kepler.configuration;
031
032import java.io.File;
033import java.util.List;
034import java.util.Locale;
035
036import org.kepler.build.modules.Module;
037
038/**
039 * An interface to the deserialization methods required by the configuration
040 * manager to deserialize properties
041 */
042public interface ConfigurationReader
043{
044  /**
045   * load all configurations for a given module
046   */
047  public List<RootConfigurationProperty> loadConfigurations(Module m)
048    throws ConfigurationManagerException;
049  
050  /**
051   * load all configuration for a given module in a given locale
052   */
053  public List<RootConfigurationProperty> loadConfigurations(Module m, Locale l)
054    throws ConfigurationManagerException;
055  
056  /**
057   * load a single configuration file from a module
058   */
059  public RootConfigurationProperty loadConfiguration(Module m, File f)
060    throws ConfigurationManagerException;
061    
062  /**
063   * load a single configuration file from a module for a given locale
064   */
065  public RootConfigurationProperty loadConfiguration(Module m, File f, Locale l)
066    throws ConfigurationManagerException;
067
068}