/**
    * Copyright (C) cedarsoft GmbH.
    *
    * Licensed under the GNU General Public License version 3 (the "License")
    * with Classpath Exception; you may not use this file except in compliance
    * with the License. You may obtain a copy of the License at
    *
    *         http://www.cedarsoft.org/gpl3ce
    *         (GPL 3 with Classpath Exception)
   *
   * This code is free software; you can redistribute it and/or modify it
   * under the terms of the GNU General Public License version 3 only, as
   * published by the Free Software Foundation. cedarsoft GmbH designates this
   * particular file as subject to the "Classpath" exception as provided
   * by cedarsoft GmbH in the LICENSE file that accompanied this code.
   *
   * This code is distributed in the hope that it will be useful, but WITHOUT
   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
   * version 3 for more details (a copy is included in the LICENSE file that
   * accompanied this code).
   *
   * You should have received a copy of the GNU General Public License version
   * 3 along with this work; if not, write to the Free Software Foundation,
   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * Please contact cedarsoft GmbH, 72810 Gomaringen, Germany,
   * or visit www.cedarsoft.com if you need additional information or
   * have any questions.
   */
  
  package com.cedarsoft.serialization;
  
  import com.cedarsoft.AssertUtils;
  import org.jdom.Document;
  import org.jdom.Element;
  import org.jdom.JDOMException;
  import org.jdom.Namespace;
  import org.jdom.input.SAXBuilder;
  import org.jdom.output.Format;
  import org.jdom.output.XMLOutputter;
  
  import javax.annotation.Nonnull;
  import java.io.ByteArrayInputStream;
  import java.io.IOException;
  
  /**
   * Abstract base class for XML based serializers.
   * <p/>
   * <p/>
   * Attention: it is necessary to define at least one DataPoint:
   * <p/>
   * <pre>&#064;DataPoint<br/>public static final Entry&lt;?&gt; ENTRY1 = create(<br/> new DomainObject(),<br/> &quot;&lt;xml/&gt;&quot; );</pre>
   *
   * @param <T> the type of the serialized object
   */
  public abstract class AbstractXmlSerializerTest2<T> extends AbstractSerializerTest2<T> {
    protected void verify( @Nonnull byte[] current, @Nonnull byte[] exectedXml ) throws Exception {
      if ( addNameSpace() ) {
        String expectedWithNamespace = addNameSpace( ( AbstractXmlSerializer<?, ?, ?, ?> ) getSerializer(), exectedXml );
        AssertUtils.assertXMLEquals( expectedWithNamespace, new String( current ) );
      } else {
        AssertUtils.assertXMLEquals( new String( exectedXml ), new String( current ) );
      }
    }
  
    @Override
    protected void verifySerialized( @Nonnull Entry<T> entry, @Nonnull byte[] serialized ) throws Exception {
      verify( serialized, entry.getExpected() );
    }
  
    protected boolean addNameSpace() {
      return true;
    }
  
  
    @Nonnull
  
    public static String addNameSpace( @Nonnull AbstractXmlSerializer<?, ?, ?, ?> serializer, @Nonnull byte[] xmlBytes ) throws Exception {
      return addNameSpace( serializer.createNameSpace( serializer.getFormatVersion() ), xmlBytes );
    }
  
    public static String addNameSpace( @Nonnull String nameSpaceUri, @Nonnull byte[] xml ) throws JDOMException, IOException {
      Document doc = new SAXBuilder().build( new ByteArrayInputStream( xml ) );
  
      Element root = doc.getRootElement();
      if ( root.getNamespaceURI().length() == 0 ) {
        Namespace namespace = Namespace.getNamespace( nameSpaceUri );
  
        addNameSpaceRecursively( root, namespace );
      }
  
      return new XMLOutputter( Format.getPrettyFormat() ).outputString( doc );
    }
  
    public static void addNameSpaceRecursively( @Nonnull Element element, @Nonnull Namespace namespace ) {
      element.setNamespace( namespace );
      for ( Element child : ( ( Iterable<? extends Element> ) element.getChildren() ) ) {
        addNameSpaceRecursively( child, namespace );
     }
   }
 
   @Nonnull
   protected static <T> Entry<? extends T> create( @Nonnull T object, @Nonnull String expected ) {
     return new Entry<T>( object, expected.getBytes() );
   }
 }