/*
    * Copyright 2012 The Apache Software Foundation.
    *
    * 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 javax.faces.component;
  
  import java.io.Serializable;
  import javax.faces.context.FacesContext;
  import javax.faces.convert.Converter;
  import javax.faces.convert.LongConverter;
  import junit.framework.Assert;
  import org.apache.myfaces.test.base.junit4.AbstractJsfTestCase;
  import org.junit.Test;
  
  /**
   *
   * @author lu4242
   */
  public class UIOutputPSSTest extends AbstractJsfTestCase
  {
      
      /**
       * Check null delta when converter only implements Converter interface.
       * 
       * @throws Exception 
       */
      @Test
      public void testConverterDeltaState1() throws Exception
      {
          UIOutput output = new UIOutput();
          output.setId("output1");
          output.setConverter(new LongConverter());
          output.markInitialState();
          
          Object state1 = output.saveState(facesContext);
          
          // null delta expected
          Assert.assertNull(state1);
          
          UIOutput output2 = new UIOutput();
          output2.setId("output1");
          Converter converter2 = new LongConverter();
          output2.setConverter(converter2);
          output2.markInitialState();
          
          output2.restoreState(facesContext, state1);
          
          // Check converter is not replaced, because it is not necessary
          Assert.assertEquals(converter2, output2.getConverter());
      }
      
      @Test
      public void testConverterDeltaState2() throws Exception
      {
          UIOutput output = new UIOutput();
          output.setId("output1");
          output.setConverter(new LongSerializableConverter());
          output.markInitialState();
          
          Object state1 = output.saveState(facesContext);
          
          // null delta expected
          Assert.assertNull(state1);
          
          UIOutput output2 = new UIOutput();
          output2.setId("output1");
          Converter converter2 = new LongSerializableConverter();
          output2.setConverter(converter2);
          output2.markInitialState();
          
          output2.restoreState(facesContext, state1);
          
          // Check converter is not replaced, because it is not necessary
          Assert.assertEquals(converter2, output2.getConverter());
      }
      
      @Test
      public void testConverterDeltaState3() throws Exception
      {
          UIOutput output = new UIOutput();
          output.setId("output1");
          output.setConverter(new LongStateHolderConverter());
          output.markInitialState();
          
          Object state1 = output.saveState(facesContext);
          
          // StateHolder only force always to save the state
          Assert.assertNotNull(state1);
         
         UIOutput output2 = new UIOutput();
         output2.setId("output1");
         Converter converter2 = new LongStateHolderConverter();
         output2.setConverter(converter2);
         output2.markInitialState();
         
         output2.restoreState(facesContext, state1);
         
         // Check converter IS replaced, because it should be always stored into the state
         Assert.assertNotSame(converter2, output2.getConverter());
     }
     
     @Test
     public void testConverterDeltaState4() throws Exception
     {
         UIOutput output = new UIOutput();
         output.setId("output1");
         output.setConverter(new LongPartialStateHolderConverter());
         output.markInitialState();
         
         Object state1 = output.saveState(facesContext);
         
         // PartialStateHolder only save state if delta is null
         Assert.assertNull(state1);
         
         UIOutput output2 = new UIOutput();
         output2.setId("output1");
         Converter converter2 = new LongPartialStateHolderConverter();
         output2.setConverter(converter2);
         output2.markInitialState();
         
         output2.restoreState(facesContext, state1);
         
         // Check converter is not replaced, because it is not necessary
         Assert.assertEquals(converter2, output2.getConverter());
     }
     
     @Test
     public void testConverterDeltaState5() throws Exception
     {
         UIOutput output = new UIOutput();
         output.setId("output1");
         output.setConverter(new LongPartialStateHolderConverter2());
         output.markInitialState();
         
         Object state1 = output.saveState(facesContext);
         
         // PartialStateHolder only save state if delta is null
         Assert.assertNotNull(state1);
         
         UIOutput output2 = new UIOutput();
         output2.setId("output1");
         Converter converter2 = new LongPartialStateHolderConverter2();
         output2.setConverter(converter2);
         output2.markInitialState();
         
         output2.restoreState(facesContext, state1);
         
         // Check converter is not replaced, because it is not necessary (delta change)
         Assert.assertEquals(converter2, output2.getConverter());
     }
     
     @Test
     public void testConverterDeltaState6() throws Exception
     {
         UIOutput output = new UIOutput();
         output.setId("output1");
         output.setConverter(new LongConverter());
         output.markInitialState();
         
         //Force parentDelta to be not null
         output.getAttributes().put("style", "style1");
         
         Object[] state1 = (Object[])output.saveState(facesContext);
         
         // null delta expected
         Assert.assertNotNull(state1);
         Assert.assertEquals(state1.length, 1);
         
         UIOutput output2 = new UIOutput();
         output2.setId("output1");
         Converter converter2 = new LongConverter();
         output2.setConverter(converter2);
         output2.markInitialState();
         
         output2.restoreState(facesContext, state1);
         
         // Check converter is not replaced, because it is not necessary
         Assert.assertEquals(converter2, output2.getConverter());
         
         // Check parentDelta works
         Assert.assertEquals("style1", output2.getAttributes().get("style"));
     }
 
     @Test
     public void testConverterDeltaState7() throws Exception
     {
         UIOutput output = new UIOutput();
         output.setId("output1");
         output.setConverter(new LongSerializableConverter());
         output.markInitialState();
         
         //Force parentDelta to be not null
         output.getAttributes().put("style", "style1");
         
         Object[] state1 = (Object[])output.saveState(facesContext);
         
         // null delta expected
         Assert.assertNotNull(state1);
         Assert.assertEquals(state1.length, 1);
         
         UIOutput output2 = new UIOutput();
         output2.setId("output1");
         Converter converter2 = new LongSerializableConverter();
         output2.setConverter(converter2);
         output2.markInitialState();
         
         output2.restoreState(facesContext, state1);
         
         // Check converter is not replaced, because it is not necessary
         Assert.assertEquals(converter2, output2.getConverter());
         
         // Check parentDelta works
         Assert.assertEquals("style1", output2.getAttributes().get("style"));
     }
     
     @Test
     public void testConverterDeltaState8() throws Exception
     {
         UIOutput output = new UIOutput();
         output.setId("output1");
         output.setConverter(new LongStateHolderConverter());
         output.markInitialState();
         
         //Force parentDelta to be not null
         output.getAttributes().put("style", "style1");
         
         Object[] state1 = (Object[])output.saveState(facesContext);
         
         // StateHolder force state
         Assert.assertNotNull(state1);
         Assert.assertEquals(state1.length, 2);
         Assert.assertNotNull(state1[1]);
         Assert.assertNotNull(state1[0]);
         
         UIOutput output2 = new UIOutput();
         output2.setId("output1");
         Converter converter2 = new LongStateHolderConverter();
         output2.setConverter(converter2);
         output2.markInitialState();
         
         output2.restoreState(facesContext, state1);
         
         // Check converter IS replaced, because it should be always stored into the state
         Assert.assertNotSame(converter2, output2.getConverter());
         
         // Check parentDelta works
         Assert.assertEquals("style1", output2.getAttributes().get("style"));
     }
 
     @Test
     public void testConverterDeltaState9() throws Exception
     {
         UIOutput output = new UIOutput();
         output.setId("output1");
         output.setConverter(new LongPartialStateHolderConverter());
         output.markInitialState();
         
         //Force parentDelta to be not null
         output.getAttributes().put("style", "style1");
         
         Object[] state1 = (Object[])output.saveState(facesContext);
         
         // null delta expected
         Assert.assertNotNull(state1);
         Assert.assertEquals(state1.length, 1);
         
         UIOutput output2 = new UIOutput();
         output2.setId("output1");
         Converter converter2 = new LongPartialStateHolderConverter();
         output2.setConverter(converter2);
         output2.markInitialState();
         
         output2.restoreState(facesContext, state1);
         
         // Check converter is not replaced, because it is not necessary
         Assert.assertEquals(converter2, output2.getConverter());
         
         // Check parentDelta works
         Assert.assertEquals("style1", output2.getAttributes().get("style"));
     }
     
     @Test
     public void testConverterDeltaState10() throws Exception
     {
         UIOutput output = new UIOutput();
         output.setId("output1");
         output.setConverter(new LongPartialStateHolderConverter2());
         output.markInitialState();
         
         //Force parentDelta to be not null
         output.getAttributes().put("style", "style1");
         
         Object[] state1 = (Object[])output.saveState(facesContext);
         
         // PartialStateHolder force state only when there is delta
         Assert.assertNotNull(state1);
         Assert.assertEquals(state1.length, 2);
         Assert.assertNotNull(state1[1]);
         Assert.assertNotNull(state1[0]);
         
         UIOutput output2 = new UIOutput();
         output2.setId("output1");
         Converter converter2 = new LongPartialStateHolderConverter2();
         output2.setConverter(converter2);
         output2.markInitialState();
         
         output2.restoreState(facesContext, state1);
         
         // Check converter is not replaced, because it is not necessary (delta change)
         Assert.assertEquals(converter2, output2.getConverter());
         
         // Check parentDelta works
         Assert.assertEquals("style1", output2.getAttributes().get("style"));
     }
     
     /**
      * Check set null converter after markInitialState case
      * 
      * @throws Exception 
      */
     @Test
     public void testConverterDeltaState11() throws Exception
     {
         Converter[] converters = new Converter[]{
             new LongConverter(),
             new LongSerializableConverter(),
             new LongStateHolderConverter(),
             new LongPartialStateHolderConverter(),
             new LongPartialStateHolderConverter2()
         };
         Converter[] converters2 = new Converter[]{
             new LongConverter(),
             new LongSerializableConverter(),
             new LongStateHolderConverter(),
             new LongPartialStateHolderConverter(),
             new LongPartialStateHolderConverter2()
         };
         for (int i = 0; i < converters.length; i++)
         {
             UIOutput output = new UIOutput();
             output.setId("output1");
             output.setConverter(converters[i]);
             output.markInitialState();
 
             output.setConverter(null);
 
             Object[] state1 = (Object[])output.saveState(facesContext);
 
             // The null spot force state to be set.
             Assert.assertNotNull(state1);
             Assert.assertEquals(state1.length, 2);
             Assert.assertNull(state1[1]); // null spot in state means null Converter
             Assert.assertNotNull(state1[0]); //because _isConverterSet()
 
             UIOutput output2 = new UIOutput();
             output2.setId("output1");
             Converter converter2 = converters2[i];
             output2.setConverter(converter2);
             output2.markInitialState();
 
             output2.restoreState(facesContext, state1);
 
             // Check converter is set to null
             Assert.assertNull(output2.getConverter());
         }
     }
 
     @Test
     public void testConverterDeltaState12() throws Exception
     {
         UIOutput output = new UIOutput();
         output.setId("output1");
         output.setConverter(new LongTransientStateHolderConverter());
         output.markInitialState();
         
         Object state1 = output.saveState(facesContext);
         
         // Transient means no state, but the effect is the converter dissapear
         // (because is transient, and in JSF 1.2/1.1 that was the effect).
         Assert.assertNotNull(state1);
         
         UIOutput output2 = new UIOutput();
         output2.setId("output1");
         Converter converter2 = new LongTransientStateHolderConverter();
         output2.setConverter(converter2);
         output2.markInitialState();
         
         output2.restoreState(facesContext, state1);
         
         // Check no converter should be found
         Assert.assertNull(output2.getConverter());
     }
     
     @Test
     public void testConverterDeltaState13() throws Exception
     {
         UIOutput output = new UIOutput();
         output.setId("output1");
         output.setConverter(new LongTransientPartialStateHolderConverter());
         output.markInitialState();
         
         Object state1 = output.saveState(facesContext);
         
         // Transient means no state, but the effect is the converter dissapear
         // (because is transient, and in JSF 1.2/1.1 that was the effect).
         Assert.assertNotNull(state1);
         
         UIOutput output2 = new UIOutput();
         output2.setId("output1");
         Converter converter2 = new LongTransientPartialStateHolderConverter();
         output2.setConverter(converter2);
         output2.markInitialState();
         
         output2.restoreState(facesContext, state1);
         
         // Check no converter should be found
         Assert.assertNull(output2.getConverter());
     }
 
     public static class LongSerializableConverter extends LongConverter implements Serializable
     {
         
     }
     
     public static class LongStateHolderConverter extends LongConverter implements StateHolder
     {
         public Object saveState(FacesContext context)
         {
             return null;
         }
 
         public void restoreState(FacesContext context, Object state)
         {
         }
 
         public boolean isTransient()
         {
             return false;
         }
 
         public void setTransient(boolean newTransientValue)
         {
         }
 
     }
     
     public static class LongTransientStateHolderConverter extends LongConverter implements StateHolder
     {
         public Object saveState(FacesContext context)
         {
             return null;
         }
 
         public void restoreState(FacesContext context, Object state)
         {
         }
 
         public boolean isTransient()
         {
             return true;
         }
 
         public void setTransient(boolean newTransientValue)
         {
         }
 
     }
     
     public static class LongPartialStateHolderConverter extends LongConverter implements PartialStateHolder
     {
         private boolean _markInitialState;
 
         public void clearInitialState()
         {
             _markInitialState = false;
         }
 
         public boolean initialStateMarked()
         {
             return _markInitialState;
         }
 
         public void markInitialState()
         {
             _markInitialState = true;
         }
         
         public Object saveState(FacesContext context)
         {
             return null;
         }
 
         public void restoreState(FacesContext context, Object state)
         {
         }
 
         public boolean isTransient()
         {
             return false;
         }
 
         public void setTransient(boolean newTransientValue)
         {
         }
     }
     
     public static class LongPartialStateHolderConverter2 
         extends LongPartialStateHolderConverter implements PartialStateHolder
     {
         
         public Object saveState(FacesContext context)
         {
             return 1;
         }
 
         public void restoreState(FacesContext context, Object state)
         {
             //ignore
         }
 
         public boolean isTransient()
         {
             return false;
         }
 
         public void setTransient(boolean newTransientValue)
         {
         }
     }
     
     public static class LongTransientPartialStateHolderConverter
         extends LongPartialStateHolderConverter implements PartialStateHolder
     {
         
         public Object saveState(FacesContext context)
         {
             return 1;
         }
 
         public void restoreState(FacesContext context, Object state)
         {
             //ignore
         }
 
         public boolean isTransient()
         {
             return true;
         }
 
         public void setTransient(boolean newTransientValue)
         {
         }
     }
     
 }