/*

  * 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.at.classpath;

 import java.net.URL;

 import java.util.List;

 import org.hibernate.validator.constraints.NotBlank;

 import de.smartics.properties.api.core.annotations.AccessType;

 import de.smartics.properties.api.core.annotations.PropertyElementType;

 import de.smartics.properties.api.core.annotations.PropertyLifecycle;

 import de.smartics.properties.api.core.annotations.PropertySet;

 import de.smartics.properties.api.core.domain.PropertyDescriptor;

 import de.smartics.properties.api.core.domain.PropertyKey;

 /**

  * Provides sample application properties.

  */

 @PropertySet("app")

 public interface ApplicationProperties

 {

   /**

    * The URL to the application to be used from within the application.

    *

    * @return the URL to the application to be used from within the application.

    */

   @NotBlank

   @PropertySet("app.server")

   @PropertyLifecycle(access = AccessType.READ_WRITE)

   String url();

   /**

    * The property key for the {@link #url()} property.

    *

    * @return the property key for the {@link #url()} property.

    */

   PropertyKey getUrlPropertyKey();

   /**

    * The domain the application is assigned to.

    *

    * @return the domain the application is assigned to.

    */

   @NotBlank

   String domain();

   /**

    * The URL to the application to be used from within the application.

    *

    * @return the URL to the application to be used from within the application.

    */

   URL homePage();

   /**

    * The property key for the {@link #homePage()} property.

    *

    * @return the property key for the {@link #homePage()} property.

    */

   PropertyKey getHomePagePropertyKey();

   /**

    * The property descriptor for the {@link #homePage()} property.

    *

    * @return the property descriptor for the {@link #homePage()} property.

    */

   PropertyDescriptor getHomePagePropertyDescriptor();

   /**

    * A list of optional additional URLs.

    *

    * @return list of optional additional URLs.

    */

   @PropertyElementType(URL.class)

   List<URL> additionalUrls();

 }