/*
    * 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.tutorial.property.list;
  
  import static org.hamcrest.MatcherAssert.assertThat;
  import static org.hamcrest.Matchers.contains;
  
  import java.util.List;
  
  import org.junit.Before;
  import org.junit.Test;
  
  import de.smartics.projectdoc.annotations.DocCategory;
  import de.smartics.projectdoc.annotations.Document;
  import de.smartics.projectdoc.annotations.topic.DocChapter;
  import de.smartics.projectdoc.annotations.topic.DocSection;
  import de.smartics.properties.api.core.domain.PropertyKey;
  import de.smartics.properties.api.core.domain.PropertyValidationException;
  import de.smartics.properties.impl.config.classpath.ClasspathConfigurationProperties;
  import de.smartics.properties.impl.config.classpath.ClasspathConfigurationPropertiesFactory;
  
  /**
   * This tutorial provides information about putting constraints on lists and
   * list elements.
   */
  @Document(title = "List Properties Constraints", sortKey = "basics0110")
  @DocCategory({ "basics" })
  // @DocTopic(path="basics", step="110")
  public class ListPropertyConstraintsTutorial
  {
    private ClasspathConfigurationProperties config;
  
    private ListPropertiesWithConstraints properties;
  
    @Before
    public void setUp()
    {
      config = createConfiguration();
      properties = config.getProperties(ListPropertiesWithConstraints.class);
    }
  
    private static ClasspathConfigurationProperties createConfiguration()
    {
      final ClasspathConfigurationPropertiesFactory factory =
          new ClasspathConfigurationPropertiesFactory();
      final ClasspathConfigurationProperties config = factory.create();
      config.addClassPathProperties(ListPropertiesWithConstraints.class);
      return config;
    }
  
    /**
     * <p>
     * Constraints on lists and their elements are declared like this:
     * </p>
     * {@insertCode source="ListPropertiesWithConstraints"}
     * <p>
     * Accessing a list of values is straight forward.
     * </p>
     * {@insertCode}
     */
    @Test
    @DocChapter
    public void propertiesWithConstraints()
    {
      final List<Integer> list = properties.intList();
      assertThat(list, contains(2, 3, 4));
    }
  
    /**
     * <p>
     * This example simply shows, that the constraint on a list as whole works.
     * </p>
     * {@insertCode}
     */
    @Test(expected = PropertyValidationException.class)
    @DocSection
    public void listConstraintsAtWork()
    {
      final PropertyKey key = properties.intListPropertyKey();
      config.setProperty(key, "3, 3, 3, 3, 3, 3, 3");
      properties.intList();
    }
  
    /**
     * <p>
     * And this example simply shows, that the constraints on the elements work.
    * </p>
    * {@insertCode}
    */
   @Test(expected = PropertyValidationException.class)
   @DocSection
   public void listElementConstraintsAtWork()
   {
     final PropertyKey key = properties.intListPropertyKey();
     config.setProperty(key, "3, 10, 3");
     properties.intList();
   }
 }