Added warning about reimplementation to classes in package ctc. (#812)

* Added deprecation notice to package. * Added warnings to all classes about refactoring. * Changed formatting for javadoc
w3c · Feb 28, 2018 · 7eafa7b · 7eafa7b
1 parent befd9fc
commit 7eafa7b
Show file tree

Hide file tree

Showing 48 changed files with 337 additions and 8 deletions.
diff --git a/src/main/java/com/adobe/epubcheck/ctc/CheckManager.java b/src/main/java/com/adobe/epubcheck/ctc/CheckManager.java
@@ -7,6 +7,13 @@
 import com.adobe.epubcheck.ctc.epubpackage.EpubPackage;
 import com.adobe.epubcheck.util.EPUBVersion;
 
+/**
+ *  ===  WARNING  ==========================================<br/>
+ *  This class is scheduled to be refactored and integrated<br/>
+ *  in another package.<br/>
+ *  Please keep changes minimal (bug fixes only) until then.<br/>
+ *  ========================================================<br/>
+ */
 public class CheckManager
 {
   private final EpubPackage epack;

diff --git a/src/main/java/com/adobe/epubcheck/ctc/ContentValidator.java b/src/main/java/com/adobe/epubcheck/ctc/ContentValidator.java
@@ -4,7 +4,13 @@
 import com.adobe.epubcheck.ctc.epubpackage.EpubPackage;
 import com.adobe.epubcheck.opf.DocumentValidator;
 
-
+/**
+ *  ===  WARNING  ==========================================<br/>
+ *  This class is scheduled to be refactored and integrated<br/>
+ *  in another package.<br/>
+ *  Please keep changes minimal (bug fixes only) until then.<br/>
+ *  ========================================================<br/>
+ */
 public interface ContentValidator
 {
   public enum ValidationType

diff --git a/src/main/java/com/adobe/epubcheck/ctc/EntitySearch.java b/src/main/java/com/adobe/epubcheck/ctc/EntitySearch.java
@@ -20,6 +20,13 @@
 import com.adobe.epubcheck.ocf.EncryptionFilter;
 import com.adobe.epubcheck.util.EPUBVersion;
 
+/**
+ *  ===  WARNING  ==========================================
+ *  This class is scheduled to be refactored and integrated
+ *  in another package.
+ *  Please keep changes minimal (bug fixes only) until then.
+ *  ========================================================
+ */
 class EntitySearch extends TextSearch
 {
   static final Pattern entityPattern = Pattern.compile("&([A-Za-z0-9]+)([;|\\s])");

diff --git a/src/main/java/com/adobe/epubcheck/ctc/Epub3StructureCheck.java b/src/main/java/com/adobe/epubcheck/ctc/Epub3StructureCheck.java
@@ -11,6 +11,13 @@
 import com.adobe.epubcheck.util.SearchDictionary;
 import com.adobe.epubcheck.util.SearchDictionary.DictionaryType;
 
+/**
+ *  ===  WARNING  ==========================================<br/>
+ *  This class is scheduled to be refactored and integrated<br/>
+ *  in another package.<br/>
+ *  Please keep changes minimal (bug fixes only) until then.<br/>
+ *  ========================================================<br/>
+ */
 public class Epub3StructureCheck implements DocumentValidator
 {
   private final Report report;
@@ -22,7 +29,6 @@ public Epub3StructureCheck(EpubPackage epack, Report report)
     this.epack = epack;
   }
 
-
   @Override
   public boolean validate()
   {

diff --git a/src/main/java/com/adobe/epubcheck/ctc/EpubCSSCheck.java b/src/main/java/com/adobe/epubcheck/ctc/EpubCSSCheck.java
@@ -28,6 +28,13 @@
 import com.adobe.epubcheck.util.SearchDictionary.DictionaryType;
 import com.adobe.epubcheck.util.TextSearchDictionaryEntry;
 
+/**
+ *  ===  WARNING  ==========================================<br/>
+ *  This class is scheduled to be refactored and integrated<br/>
+ *  in another package.<br/>
+ *  Please keep changes minimal (bug fixes only) until then.<br/>
+ *  ========================================================<br/>
+ */
 public class EpubCSSCheck implements DocumentValidator
 {
   final ZipFile zip;

diff --git a/src/main/java/com/adobe/epubcheck/ctc/EpubCfiCheck.java b/src/main/java/com/adobe/epubcheck/ctc/EpubCfiCheck.java
@@ -15,7 +15,13 @@
 import com.adobe.epubcheck.util.SearchDictionary;
 import com.adobe.epubcheck.util.SearchDictionary.DictionaryType;
 
-
+/**
+ *  ===  WARNING  ==========================================<br/>
+ *  This class is scheduled to be refactored and integrated<br/>
+ *  in another package.<br/>
+ *  Please keep changes minimal (bug fixes only) until then.<br/>
+ *  ========================================================<br/>
+ */
 public class EpubCfiCheck implements DocumentValidator
 {
   private final Report report;

diff --git a/src/main/java/com/adobe/epubcheck/ctc/EpubCheckContentFactory.java b/src/main/java/com/adobe/epubcheck/ctc/EpubCheckContentFactory.java
@@ -4,6 +4,13 @@
 import com.adobe.epubcheck.ctc.epubpackage.EpubPackage;
 import com.adobe.epubcheck.opf.DocumentValidator;
 
+/**
+ *  ===  WARNING  ==========================================<br/>
+ *  This class is scheduled to be refactored and integrated<br/>
+ *  in another package.<br/>
+ *  Please keep changes minimal (bug fixes only) until then.<br/>
+ *  ========================================================<br/>
+ */
 public class EpubCheckContentFactory implements ContentValidator
 {
   static private final EpubCheckContentFactory instance = new EpubCheckContentFactory();

diff --git a/src/main/java/com/adobe/epubcheck/ctc/EpubExtLinksCheck.java b/src/main/java/com/adobe/epubcheck/ctc/EpubExtLinksCheck.java
@@ -18,7 +18,13 @@
 import com.adobe.epubcheck.util.SearchDictionary.DictionaryType;
 import com.adobe.epubcheck.util.TextSearchDictionaryEntry;
 
-
+/**
+ *  ===  WARNING  ==========================================<br/>
+ *  This class is scheduled to be refactored and integrated<br/>
+ *  in another package.<br/>
+ *  Please keep changes minimal (bug fixes only) until then.<br/>
+ *  ========================================================<br/>
+ */
 public class EpubExtLinksCheck implements DocumentValidator
 {
   private final Report report;

diff --git a/src/main/java/com/adobe/epubcheck/ctc/EpubHTML5StructureCheck.java b/src/main/java/com/adobe/epubcheck/ctc/EpubHTML5StructureCheck.java
@@ -24,6 +24,13 @@
 import com.adobe.epubcheck.util.SearchDictionary;
 import com.adobe.epubcheck.util.SearchDictionary.DictionaryType;
 
+/**
+ *  ===  WARNING  ==========================================<br/>
+ *  This class is scheduled to be refactored and integrated<br/>
+ *  in another package.<br/>
+ *  Please keep changes minimal (bug fixes only) until then.<br/>
+ *  ========================================================<br/>
+ */
 public class EpubHTML5StructureCheck implements DocumentValidator
 {
   static final int hasHtml = 1;

diff --git a/src/main/java/com/adobe/epubcheck/ctc/EpubLangCheck.java b/src/main/java/com/adobe/epubcheck/ctc/EpubLangCheck.java
@@ -14,6 +14,13 @@
 import com.adobe.epubcheck.util.SearchDictionary;
 import com.adobe.epubcheck.util.SearchDictionary.DictionaryType;
 
+/**
+ *  ===  WARNING  ==========================================<br/>
+ *  This class is scheduled to be refactored and integrated<br/>
+ *  in another package.<br/>
+ *  Please keep changes minimal (bug fixes only) until then.<br/>
+ *  ========================================================<br/>
+ */
 public class EpubLangCheck implements DocumentValidator
 {
   private final ZipFile zip;

diff --git a/src/main/java/com/adobe/epubcheck/ctc/EpubMetaDataV2Check.java b/src/main/java/com/adobe/epubcheck/ctc/EpubMetaDataV2Check.java
@@ -6,6 +6,13 @@
 import com.adobe.epubcheck.ctc.epubpackage.EpubPackage;
 import com.adobe.epubcheck.opf.DocumentValidator;
 
+/**
+ *  ===  WARNING  ==========================================<br/>
+ *  This class is scheduled to be refactored and integrated<br/>
+ *  in another package.<br/>
+ *  Please keep changes minimal (bug fixes only) until then.<br/>
+ *  ========================================================<br/>
+ */
 public class EpubMetaDataV2Check implements DocumentValidator
 {
   private final Document doc;

diff --git a/src/main/java/com/adobe/epubcheck/ctc/EpubMetaDataV3Check.java b/src/main/java/com/adobe/epubcheck/ctc/EpubMetaDataV3Check.java
@@ -6,6 +6,13 @@
 import com.adobe.epubcheck.ctc.epubpackage.EpubPackage;
 import com.adobe.epubcheck.opf.DocumentValidator;
 
+/**
+ *  ===  WARNING  ==========================================<br/>
+ *  This class is scheduled to be refactored and integrated<br/>
+ *  in another package.<br/>
+ *  Please keep changes minimal (bug fixes only) until then.<br/>
+ *  ========================================================<br/>
+ */
 public class EpubMetaDataV3Check implements DocumentValidator
 {
 

diff --git a/src/main/java/com/adobe/epubcheck/ctc/EpubNCXCheck.java b/src/main/java/com/adobe/epubcheck/ctc/EpubNCXCheck.java
@@ -23,6 +23,13 @@
 import com.adobe.epubcheck.util.FeatureEnum;
 import com.adobe.epubcheck.util.PathUtil;
 
+/**
+ *  ===  WARNING  ==========================================<br/>
+ *  This class is scheduled to be refactored and integrated<br/>
+ *  in another package.<br/>
+ *  Please keep changes minimal (bug fixes only) until then.<br/>
+ *  ========================================================<br/>
+ */
 public class EpubNCXCheck implements DocumentValidator
 {
   private final XmlDocParser docParser;

diff --git a/src/main/java/com/adobe/epubcheck/ctc/EpubNavCheck.java b/src/main/java/com/adobe/epubcheck/ctc/EpubNavCheck.java
@@ -25,6 +25,13 @@
 import com.adobe.epubcheck.util.HandlerUtil;
 import com.adobe.epubcheck.util.PathUtil;
 
+/**
+ *  ===  WARNING  ==========================================<br/>
+ *  This class is scheduled to be refactored and integrated<br/>
+ *  in another package.<br/>
+ *  Please keep changes minimal (bug fixes only) until then.<br/>
+ *  ========================================================<br/>
+ */
 public class EpubNavCheck implements DocumentValidator
 {
 

diff --git a/src/main/java/com/adobe/epubcheck/ctc/EpubRenditionCheck.java b/src/main/java/com/adobe/epubcheck/ctc/EpubRenditionCheck.java
@@ -10,6 +10,13 @@
 import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
 
+/**
+ *  ===  WARNING  ==========================================<br/>
+ *  This class is scheduled to be refactored and integrated<br/>
+ *  in another package.<br/>
+ *  Please keep changes minimal (bug fixes only) until then.<br/>
+ *  ========================================================<br/>
+ */
 public class EpubRenditionCheck implements DocumentValidator
 {
   private final Document doc;

diff --git a/src/main/java/com/adobe/epubcheck/ctc/EpubSVGCheck.java b/src/main/java/com/adobe/epubcheck/ctc/EpubSVGCheck.java
@@ -16,6 +16,13 @@
 import com.adobe.epubcheck.opf.DocumentValidator;
 import com.adobe.epubcheck.util.SearchDictionary;
 
+/**
+ *  ===  WARNING  ==========================================<br/>
+ *  This class is scheduled to be refactored and integrated<br/>
+ *  in another package.<br/>
+ *  Please keep changes minimal (bug fixes only) until then.<br/>
+ *  ========================================================<br/>
+ */
 public class EpubSVGCheck implements DocumentValidator
 {
   private static final String svgNS = "http://www.w3.org/2000/svg";

diff --git a/src/main/java/com/adobe/epubcheck/ctc/EpubScriptCheck.java b/src/main/java/com/adobe/epubcheck/ctc/EpubScriptCheck.java
@@ -23,6 +23,13 @@
 import com.adobe.epubcheck.util.SearchDictionary;
 import com.adobe.epubcheck.util.SearchDictionary.DictionaryType;
 
+/**
+ *  ===  WARNING  ==========================================<br/>
+ *  This class is scheduled to be refactored and integrated<br/>
+ *  in another package.<br/>
+ *  Please keep changes minimal (bug fixes only) until then.<br/>
+ *  ========================================================<br/>
+ */
 public class EpubScriptCheck implements DocumentValidator
 {
   private final ZipFile zip;

diff --git a/src/main/java/com/adobe/epubcheck/ctc/EpubSpanCheck.java b/src/main/java/com/adobe/epubcheck/ctc/EpubSpanCheck.java
@@ -14,6 +14,13 @@
 import com.adobe.epubcheck.util.SearchDictionary;
 import com.adobe.epubcheck.util.SearchDictionary.DictionaryType;
 
+/**
+ *  ===  WARNING  ==========================================<br/>
+ *  This class is scheduled to be refactored and integrated<br/>
+ *  in another package.<br/>
+ *  Please keep changes minimal (bug fixes only) until then.<br/>
+ *  ========================================================<br/>
+ */
 public class EpubSpanCheck implements DocumentValidator
 {
   private final ZipFile zip;

diff --git a/src/main/java/com/adobe/epubcheck/ctc/EpubSpineCheck.java b/src/main/java/com/adobe/epubcheck/ctc/EpubSpineCheck.java
@@ -14,6 +14,13 @@
 import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
 
+/**
+ *  ===  WARNING  ==========================================<br/>
+ *  This class is scheduled to be refactored and integrated<br/>
+ *  in another package.<br/>
+ *  Please keep changes minimal (bug fixes only) until then.<br/>
+ *  ========================================================<br/>
+ */
 public class EpubSpineCheck implements DocumentValidator
 {
   private static final int MAX_SPINE_ITEM_THRESHOLD = 100;

diff --git a/src/main/java/com/adobe/epubcheck/ctc/EpubStyleSheetsCheck.java b/src/main/java/com/adobe/epubcheck/ctc/EpubStyleSheetsCheck.java
@@ -11,7 +11,13 @@
 import com.adobe.epubcheck.util.SearchDictionary;
 import com.adobe.epubcheck.util.SearchDictionary.DictionaryType;
 
-
+/**
+ *  ===  WARNING  ==========================================<br/>
+ *  This class is scheduled to be refactored and integrated<br/>
+ *  in another package.<br/>
+ *  Please keep changes minimal (bug fixes only) until then.<br/>
+ *  ========================================================<br/>
+ */
 public class EpubStyleSheetsCheck implements DocumentValidator
 {
   private final Report report;

diff --git a/src/main/java/com/adobe/epubcheck/ctc/EpubTextContentCheck.java b/src/main/java/com/adobe/epubcheck/ctc/EpubTextContentCheck.java
@@ -11,6 +11,13 @@
 import com.adobe.epubcheck.util.SearchDictionary;
 import com.adobe.epubcheck.util.SearchDictionary.DictionaryType;
 
+/**
+ *  ===  WARNING  ==========================================<br/>
+ *  This class is scheduled to be refactored and integrated<br/>
+ *  in another package.<br/>
+ *  Please keep changes minimal (bug fixes only) until then.<br/>
+ *  ========================================================<br/>
+ */
 public class EpubTextContentCheck implements DocumentValidator
 {
   private final Report report;

diff --git a/src/main/java/com/adobe/epubcheck/ctc/EpubTocCheck.java b/src/main/java/com/adobe/epubcheck/ctc/EpubTocCheck.java
@@ -8,6 +8,13 @@
 import com.adobe.epubcheck.opf.DocumentValidator;
 import com.adobe.epubcheck.util.EPUBVersion;
 
+/**
+ *  ===  WARNING  ==========================================<br/>
+ *  This class is scheduled to be refactored and integrated<br/>
+ *  in another package.<br/>
+ *  Please keep changes minimal (bug fixes only) until then.<br/>
+ *  ========================================================<br/>
+ */
 public class EpubTocCheck implements DocumentValidator
 {
   private final String pathRootFile;

diff --git a/src/main/java/com/adobe/epubcheck/ctc/FileLinkSearch.java b/src/main/java/com/adobe/epubcheck/ctc/FileLinkSearch.java
@@ -12,6 +12,13 @@
 import java.util.regex.Pattern;
 import java.util.zip.ZipFile;
 
+/**
+ *  ===  WARNING  ==========================================<br/>
+ *  This class is scheduled to be refactored and integrated<br/>
+ *  in another package.<br/>
+ *  Please keep changes minimal (bug fixes only) until then.<br/>
+ *  ========================================================<br/>
+ */
 public class FileLinkSearch extends TextSearch {
     private static final Pattern fileLinkPattern = Pattern.compile("href=[\"']file://");
 

diff --git a/src/main/java/com/adobe/epubcheck/ctc/PackageReader.java b/src/main/java/com/adobe/epubcheck/ctc/PackageReader.java
@@ -18,6 +18,13 @@
 import com.adobe.epubcheck.util.EPUBVersion;
 import com.adobe.epubcheck.util.EpubConstants;
 
+/**
+ *  ===  WARNING  ==========================================<br/>
+ *  This class is scheduled to be refactored and integrated<br/>
+ *  in another package.<br/>
+ *  Please keep changes minimal (bug fixes only) until then.<br/>
+ *  ========================================================<br/>
+ */
 class PackageReader
 {
   private static final String containerEntry = "META-INF/container.xml";

diff --git a/src/main/java/com/adobe/epubcheck/ctc/TextSearch.java b/src/main/java/com/adobe/epubcheck/ctc/TextSearch.java
@@ -11,6 +11,13 @@
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipFile;
 
+/**
+ *  ===  WARNING  ==========================================<br/>
+ *  This class is scheduled to be refactored and integrated<br/>
+ *  in another package.<br/>
+ *  Please keep changes minimal (bug fixes only) until then.<br/>
+ *  ========================================================<br/>
+ */
 abstract class TextSearch {
     private final Hashtable<String, EncryptionFilter> enc;
     final ZipFile zip;

diff --git a/src/main/java/com/adobe/epubcheck/ctc/XmlDocParser.java b/src/main/java/com/adobe/epubcheck/ctc/XmlDocParser.java
@@ -29,6 +29,13 @@
 import com.adobe.epubcheck.util.EpubConstants;
 import com.adobe.epubcheck.util.NamespaceHelper;
 
+/**
+ *  ===  WARNING  ==========================================<br/>
+ *  This class is scheduled to be refactored and integrated<br/>
+ *  in another package.<br/>
+ *  Please keep changes minimal (bug fixes only) until then.<br/>
+ *  ========================================================<br/>
+ */
 class XmlDocParser
 {
   private final ZipFile zip;

diff --git a/src/main/java/com/adobe/epubcheck/ctc/css/CSSSelector.java b/src/main/java/com/adobe/epubcheck/ctc/css/CSSSelector.java
@@ -3,6 +3,13 @@
 import javax.xml.stream.Location;
 import java.util.HashMap;
 
+/**
+ *  ===  WARNING  ==========================================<br/>
+ *  This class is scheduled to be refactored and integrated<br/>
+ *  in another package.<br/>
+ *  Please keep changes minimal (bug fixes only) until then.<br/>
+ *  ========================================================<br/>
+ */
 public class CSSSelector
 {
   private final String name;