Split M3U & M3U8, remove encoding argument in read and write

- Remove encoding arguments
- Split M3U provider and playlist in M3U & M3U8

Author: Borewit

build.gradle

@@ -85,7 +85,7 @@ sourceSets {
 
 
 group = 'io.github.borewit'
-version = '3.0.1'
+version = '4.0.0'
 description = 'Lizzy'
 java.sourceCompatibility = JavaVersion.VERSION_1_9
 

src/main/java/io/github/borewit/lizzy/playlist/AbstractPlaylist.java

@@ -11,7 +11,7 @@ public abstract class AbstractPlaylistProvider implements SpecificPlaylistProvid
   @Override
   public SpecificPlaylist readFrom(final InputStream inputStream) throws IOException
   {
-    return this.readFrom(inputStream, null);
+    return this.readFrom(inputStream);
   }
 
   public static BOMInputStream wrapInBomStream(InputStream inputStream)

src/main/java/io/github/borewit/lizzy/playlist/AbstractPlaylistProvider.java

@@ -11,13 +11,16 @@
 import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
 
-public abstract class JaxbPlaylistProvider<T> extends AbstractPlaylistProvider
+public abstract class JaxbPlaylistProvider<T> extends ProviderWithTextEncoding
 {
   private final Class<T> xmlClass;
   private JAXBContext jaxbContext = null;
 
+  public static final Charset defaultXmlTextEncoding = StandardCharsets.UTF_8;
+
   public JaxbPlaylistProvider(Class<T> xmlClass)
   {
+    super(defaultXmlTextEncoding);
     this.xmlClass = xmlClass;
   }
 
@@ -38,32 +41,27 @@ private JAXBContext getJaxbContext() throws JAXBException
     }
   }
 
-  protected Charset getDefaultEncoding() {
-    return StandardCharsets.UTF_8;
-  }
-
-  protected JAXBElement<T> unmarshal(final InputStream in, final String encoding) throws JAXBException, XMLStreamException
+  protected JAXBElement<T> unmarshal(final InputStream in) throws JAXBException, XMLStreamException
   {
-    String applyEncoding = encoding == null ? this.getDefaultEncoding().toString() : encoding;
     Unmarshaller unmarshaller = this.getJaxbContext().createUnmarshaller();
-    XMLStreamReader xmlStreamReader = this.getXmlStreamReader(in, applyEncoding);
+    XMLStreamReader xmlStreamReader = this.getXmlStreamReader(in, this.textEncoding.name());
     return unmarshaller.unmarshal(xmlStreamReader, this.getXmlCLass());
   }
 
   protected Marshaller makeMarshaller(String encoding) throws JAXBException
   {
     Marshaller marshaller = this.getJaxbContext().createMarshaller();
     marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
-    marshaller.setProperty(Marshaller.JAXB_ENCODING, encoding == null ? this.getDefaultEncoding().name() : encoding);
+    marshaller.setProperty(Marshaller.JAXB_ENCODING, this.textEncoding.name());
     return marshaller;
   }
 
-  public void writeTo(Object xmlPlaylist, final OutputStream out, final String encoding) throws IOException
+  public void writeTo(Object xmlPlaylist, final OutputStream out) throws IOException
   {
     try
     {
       // Marshal the playlist.
-      Marshaller marshaller = makeMarshaller(encoding);
+      Marshaller marshaller = makeMarshaller(this.textEncoding.name());
 
       marshaller.marshal(xmlPlaylist, out);
       out.flush(); // May throw IOException.

src/main/java/io/github/borewit/lizzy/playlist/JaxbPlaylistProvider.java

@@ -6,6 +6,7 @@ public enum PlaylistFormat
   atom,
   b4s,
   m3u,
+  m3u8,
   mpcpl,
   pla,
   plist,

src/main/java/io/github/borewit/lizzy/playlist/PlaylistFormat.java

@@ -0,0 +1,17 @@
+package io.github.borewit.lizzy.playlist;
+
+import java.nio.charset.Charset;
+
+public abstract class PlaylistWithTextEncoding implements SpecificPlaylist
+{
+  protected final ProviderWithTextEncoding providerWithTextEncoding;
+
+  protected PlaylistWithTextEncoding(ProviderWithTextEncoding providerWithTextEncoding) {
+    this.providerWithTextEncoding = providerWithTextEncoding;
+  }
+
+  public void setTextEncoding(Charset textEncoding) {
+    this.providerWithTextEncoding.setTextEncoding(textEncoding);
+  }
+
+}

src/main/java/io/github/borewit/lizzy/playlist/PlaylistWithTextEncoding.java

@@ -0,0 +1,16 @@
+package io.github.borewit.lizzy.playlist;
+
+import java.nio.charset.Charset;
+
+abstract class ProviderWithTextEncoding implements SpecificPlaylistProvider
+{
+  protected Charset textEncoding;
+
+  protected ProviderWithTextEncoding(Charset defaultTextEncoding) {
+    this.textEncoding = defaultTextEncoding;
+  }
+
+  public void setTextEncoding(Charset textEncoding) {
+    this.textEncoding = textEncoding;
+  }
+}

src/main/java/io/github/borewit/lizzy/playlist/ProviderWithTextEncoding.java

@@ -42,26 +42,13 @@ public interface SpecificPlaylist
    */
   SpecificPlaylistProvider getProvider();
 
-  /**
-   * Writes this specific playlist to the specified output stream.
-   * When done, the stream may be flushed, but not closed.
-   *
-   * @param out      an output stream. Shall not be <code>null</code>.
-   * @param encoding the content encoding of the output resource, or <code>null</code> if not known.
-   * @throws NullPointerException if <code>out</code> is <code>null</code>.
-   * @throws Exception            if any error occurs during the marshalling process.
-   * @see SpecificPlaylistFactory#readFrom
-   * @see SpecificPlaylistProvider#readFrom
-   */
-  void writeTo(OutputStream out, String encoding) throws IOException;
-
   /**
    * Writes this specific playlist to the specified output stream, using default encoding
    * When done, the stream may be flushed, but not closed.
    *
    * @param out      an output stream. Shall not be <code>null</code>.
    * @throws NullPointerException if <code>out</code> is <code>null</code>.
-   * @throws Exception            if any error occurs during the marshalling process.
+   * @throws IOException            if any error occurs during the marshalling process.
    * @see SpecificPlaylistFactory#readFrom
    * @see SpecificPlaylistProvider#readFrom
    */

src/main/java/io/github/borewit/lizzy/playlist/SpecificPlaylist.java

@@ -117,8 +117,7 @@ public SpecificPlaylist readFrom(Path playlistPath, OpenOption... options) throw
       {
         try
         {
-          final String encoding = playlistPath.toString().toLowerCase().endsWith(".m3u8") ? "UTF-8" : null;
-          SpecificPlaylist specificPlaylist = playlistProvider.readFrom(is, encoding);
+          SpecificPlaylist specificPlaylist = playlistProvider.readFrom(is);
           if (specificPlaylist != null)
             return specificPlaylist;
         }
@@ -164,7 +163,7 @@ public SpecificPlaylist readFrom(final URL url) throws IOException
       final InputStream in = urlConnection.getInputStream(); // May throw IOException, UnknownServiceException.
       try
       {
-        ret = service.readFrom(in, contentEncoding); // May throw Exception. Shall not throw NullPointerException because of in.
+        ret = service.readFrom(in); // May throw Exception. Shall not throw NullPointerException because of in.
         if (ret == null) continue;
         break;
       }

src/main/java/io/github/borewit/lizzy/playlist/SpecificPlaylistFactory.java

@@ -53,35 +53,19 @@ public interface SpecificPlaylistProvider
    */
   ContentType[] getContentTypes();
 
-  /**
-   * Reads a playlist from the specified input-stream.
-   * When done, the stream remains open.
-   *
-   * @param inputStream an input stream. Shall not be <code>null</code>.
-   * @return a new playlist instance, or <code>null</code> if the format has been recognized, but the playlist is malformed.
-   * @throws NullPointerException if <code>in</code> is <code>null</code>.
-   * @throws NullPointerException if <code>logger</code> is <code>null</code>.
-   * @throws IOException          if any error occurs during the unmarshalling process.
-   * @see SpecificPlaylist#writeTo
-   * @see SpecificPlaylistFactory#readFrom
-   */
-  SpecificPlaylist readFrom(InputStream inputStream) throws IOException;
-
   /**
    * Reads a playlist from the specified input stream.
    * When done, the stream remains open.
    *
    * @param inputStream an input stream. Shall not be <code>null</code>.
-   * @param encoding    the content encoding of the input resource, or <code>null</code> if not known.
    * @return a new playlist instance, or <code>null</code> if the format has been recognized, but the playlist is malformed.
    * @throws NullPointerException if <code>in</code> is <code>null</code>.
    * @throws NullPointerException if <code>logger</code> is <code>null</code>.
    * @throws IOException          if any error occurs during the unmarshalling process.
-   * @see #readFrom(InputStream, String)
    * @see SpecificPlaylistFactory#readFrom
    * @see SpecificPlaylist#writeTo
    */
-  SpecificPlaylist readFrom(InputStream inputStream, String encoding) throws IOException;
+  SpecificPlaylist readFrom(InputStream inputStream) throws IOException;
 
   /**
    * Builds a specific representation of the given generic playlist.