/*
* Meviz - Various tools collection to work with multimedia.
- * Copyright (C) 2012, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu
+ * Copyright (C) 2012 -- 2017, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of version 2 of the GNU General Public License
package eu.svjatoslav.meviz.htmlindexer;
-import java.io.IOException;
-import java.io.UnsupportedEncodingException;
-import java.util.List;
-
import eu.svjatoslav.meviz.htmlindexer.metadata.DirectoryMetadata;
import eu.svjatoslav.meviz.htmlindexer.metadata.fileTypes.AbstractFile;
import eu.svjatoslav.meviz.htmlindexer.metadata.fileTypes.Picture;
+import java.io.IOException;
+import java.io.UnsupportedEncodingException;
+import java.util.List;
+
/**
* In order to have possibility of several different layouts per directory.
* Universal interface is defined.
- *
+ * <p>
* Layout implementation is responsible for actual HTML generation.
*/
public interface Layout {
- /**
- * Enlist directory.
- */
- public void enlistDirectory(AbstractFile directory,
- DirectoryMetadata parentDirectoryMetadata);
+ /**
+ * Enlist directory.
+ */
+ void enlistDirectory(AbstractFile directory,
+ DirectoryMetadata parentDirectoryMetadata);
- /**
- * Enlist simple file.
- */
- public void enlistFile(AbstractFile file,
- DirectoryMetadata parentDirectoryMetadata);
+ /**
+ * Enlist simple file.
+ */
+ void enlistFile(AbstractFile file,
+ DirectoryMetadata parentDirectoryMetadata);
- /**
- * Enlist image file.
- */
- public void enlistImage(Picture picture,
- DirectoryMetadata parentDirectoryMetadata);
+ /**
+ * Enlist image file.
+ */
+ void enlistImage(Picture picture,
+ DirectoryMetadata parentDirectoryMetadata);
- /**
- * Enlist video in OGV format.
- *
- * @throws UnsupportedEncodingException
- */
- public void enlistOgv(AbstractFile file,
- DirectoryMetadata parentDirectoryMetadata)
- throws UnsupportedEncodingException;
+ /**
+ * Enlist video in OGV format.
+ *
+ * @throws UnsupportedEncodingException
+ */
+ void enlistOgv(AbstractFile file,
+ DirectoryMetadata parentDirectoryMetadata)
+ ;
- /**
- * Return layout specific suffix that will be appended between
- * index(suffix).html of generated file. This way multiple layouts can
- * coexist in the same directory, each residing in its own HTML file.
- */
- public String getFileNameSuffix();
+ /**
+ * Return layout specific suffix that will be appended between
+ * index(suffix).html of generated file. This way multiple layouts can
+ * coexist in the same directory, each residing in its own HTML file.
+ */
+ String getFileNameSuffix();
- /**
- * After necessary files have been enlisted for particular directory, use
- * this method to retrieve generated HTML result.
- *
- * @param metadata
- * @throws IOException
- */
- public String getHtml(final boolean showTitle,
- final boolean doHtmlHeaderAndFooter, DirectoryMetadata metadata)
- throws IOException;
+ /**
+ * After necessary files have been enlisted for particular directory, use
+ * this method to retrieve generated HTML result.
+ *
+ * @throws IOException
+ */
+ String getHtml(final boolean showTitle,
+ final boolean doHtmlHeaderAndFooter, DirectoryMetadata metadata)
+ ;
- /**
- * Initialize layout for particular directory.
- */
- public void init(String galleryTitle, List<String> path,
- final AbstractIndexer indexer, IndexingContext context);
+ /**
+ * Initialize layout for particular directory.
+ */
+ void init(String galleryTitle, List<String> path,
+ final AbstractIndexer indexer, IndexingContext context);
- public void enlistWebm(AbstractFile file, DirectoryMetadata directory);
+ void enlistWebm(AbstractFile file, DirectoryMetadata directory);
}