/**
    * 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.Version;
  import org.apache.commons.io.IOUtils;
  import org.jdom.JDOMException;
  
  import javax.annotation.Nonnull;
  import java.io.IOException;
  import java.net.URL;
  
  /**
   * It is necessary to define at least one DataPoint
   * <pre>&#064;DataPoint<br/>public static final VersionEntry ENTRY1 = create(<br/> Version.valueOf( 1, 0, 0 ),<br/> &quot;&lt;xml/&gt;&quot; );</pre>
   *
   * @param <T> the type
   */
  public abstract class AbstractXmlVersionTest2<T> extends AbstractVersionTest2<T> {
    /**
     * Converts the xml string to a byte array used to deserialize.
     * This method automatically adds the namespace containing the version.
     *
     * @param xml        the xml
     * @param version    the version
     * @param serializer the serializer
     * @return the byte array using the xml string
     */
    @Nonnull
    protected static byte[] processXml( @Nonnull String xml, @Nonnull Version version, @Nonnull AbstractXmlSerializer<?, ?, ?, ?> serializer ) throws Exception {
      return processXml( xml, serializer.createNameSpace( version ) );
    }
  
    @Nonnull
    protected static byte[] processXml( @Nonnull byte[] xml, @Nonnull Version version, @Nonnull AbstractXmlSerializer<?, ?, ?, ?> serializer ) throws Exception {
      return processXml( xml, serializer.createNameSpace( version ) );
    }
  
    @Nonnull
    protected static byte[] processXml( @Nonnull String xml, @Nonnull String nameSpace ) throws JDOMException, IOException {
      return AbstractXmlSerializerTest2.addNameSpace( nameSpace, xml.getBytes() ).getBytes();
    }
  
    @Nonnull
    protected static byte[] processXml( @Nonnull byte[] xml, @Nonnull String nameSpace ) throws JDOMException, IOException {
      return AbstractXmlSerializerTest2.addNameSpace( nameSpace, xml ).getBytes();
    }
  
    @Nonnull
    protected static VersionEntry create( @Nonnull Version version, @Nonnull String xml ) {
      return new XmlVersionEntry( version, xml );
    }
  
    @Nonnull
    protected static VersionEntry create( @Nonnull Version version, @Nonnull URL expected ) {
      try {
        return new XmlVersionEntry( version, IOUtils.toByteArray( expected.openStream() ) );
      } catch ( IOException e ) {
        throw new RuntimeException( e );
      }
    }
  
    public static class XmlVersionEntry implements VersionEntry {
      @Nonnull
      private final Version version;
      @Nonnull
  
      private final byte[] xml;
  
      public XmlVersionEntry( @Nonnull Version version, @Nonnull byte[] xml ) {
       this.version = version;
       this.xml = xml;
     }
 
     public XmlVersionEntry( @Nonnull Version version, @Nonnull String xml ) {
       this( version, xml.getBytes() );
     }
 
     @Nonnull
     @Override
     public Version getVersion() {
       return version;
     }
 
     @Nonnull
     @Override
     public byte[] getSerialized( @Nonnull Serializer<?> serializer ) throws Exception {
       return processXml( xml, version, ( AbstractXmlSerializer<?, ?, ?, ?> ) serializer );
     }
   }
 }