/*

  * Copyright 2012-2013 smartics, Kronseder & Reiner GmbH

  *

  * Licensed under the Apache License, Version 2.0 (the "License");

  * you may not use this file except in compliance with the License.

  * You may obtain a copy of the License at

  *

  *     http://www.apache.org/licenses/LICENSE-2.0

  *

  * Unless required by applicable law or agreed to in writing, software

  * distributed under the License is distributed on an "AS IS" BASIS,

  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  * See the License for the specific language governing permissions and

  * limitations under the License.

  */

 package de.smartics.properties.impl.config.properties;

 import javax.annotation.concurrent.ThreadSafe;

 import de.smartics.properties.api.config.domain.ConfigurationException;

 import de.smartics.properties.api.config.domain.key.ApplicationId;

 import de.smartics.properties.api.config.domain.key.ConfigurationKey;

 import de.smartics.properties.api.config.domain.key.EnvironmentId;

 import de.smartics.properties.spi.config.support.AbstractConfigurationPropertiesFactory;

 /**

  * Factory to create instances of {@link PropertiesConfigurationProperties}.

  * <p>

  * This implementation fetches the properties information from the class path

  * available at runtime. Therefore the environment identifier of the passed in

  * configuration key is irrelevant to this implementation, since the environment

  * is always the local runtime of the node it is running on.

  * </p>

  */

 @ThreadSafe

 public final class PropertiesConfigurationPropertiesFactory extends

     AbstractConfigurationPropertiesFactory<PropertiesConfigurationProperties>

 {

   // ********************************* Fields *********************************

   // --- constants ------------------------------------------------------------

   /**

    * The class version identifier.

    */

   private static final long serialVersionUID = 1L;

   // --- members --------------------------------------------------------------

   // ****************************** Initializer *******************************

   // ****************************** Constructors ******************************

   /**

    * Default constructor.

    */

   public PropertiesConfigurationPropertiesFactory()

   {

   }

   // ****************************** Inner Classes *****************************

   // ********************************* Methods ********************************

   // --- init -----------------------------------------------------------------

   // --- get&set --------------------------------------------------------------

   // --- business -------------------------------------------------------------

   /**

    * Creates a configuration properties instance for an artificial environment.

    *

    * @param applicationId the identifier of the application whose properties are

    *          to be created.

    * @return the requested configuration properties. Never <code>null</code>.

    * @throws NullPointerException if {@code applicationId} is <code>null</code>.

    * @throws ConfigurationException on any problem loading the configuration

    *           properties.

    */

   public PropertiesConfigurationProperties create(

       final ApplicationId applicationId) throws NullPointerException,

     ConfigurationException

   {

     final ConfigurationKey key = createKey(applicationId);

     return createManagement(key);

   }

   private static ConfigurationKey createKey(final ApplicationId applicationId)

   {

     return new ConfigurationKey(EnvironmentId.ANY_ENV, applicationId);

   }

   /**

    * Creates a configuration properties management instance for an artificial

    * environment.

    *

    * @param applicationId the identifier of the application whose properties are

    *          to be created.

    * @return the requested configuration properties. Never <code>null</code>.

    * @throws NullPointerException if {@code applicationId} is <code>null</code>.

    * @throws ConfigurationException on any problem loading the configuration

    *           properties.

    */

   public PropertiesConfigurationProperties createManagement(

       final ApplicationId applicationId) throws NullPointerException,

     ConfigurationException

   {

     final ConfigurationKey key = createKey(applicationId);

     return createManagement(key);

   }

   @Override

   protected PropertiesConfigurationProperties createNewConfiguration(

       final ConfigurationKey key) throws NullPointerException,

     ConfigurationException

   {

     final PropertiesConfigurationProperties config =

         new PropertiesConfigurationProperties(key, getRegistry());

     return config;

   }

   // --- object basics --------------------------------------------------------

 }