From 196081a317a5709bd2dc41b87aae7b5506bbdff3 Mon Sep 17 00:00:00 2001 From: Koen De Groote Date: Tue, 29 Jun 2021 13:06:07 +0200 Subject: [PATCH] Documentation cleanup (#612) * Added the `@Deprecated` tag to instances where is was mentioned in documentation, but not for the actual code itself. Changed one documentation link pointing at a non-existing item. * As per PR suggestion. --- .../src/main/java/com/twelvemonkeys/image/IndexImage.java | 1 + .../main/java/com/twelvemonkeys/io/FilenameMaskFilter.java | 1 + .../com/twelvemonkeys/io/LittleEndianDataInputStream.java | 1 + .../src/main/java/com/twelvemonkeys/lang/StringUtil.java | 2 ++ .../src/main/java/com/twelvemonkeys/util/Time.java | 2 ++ .../com/twelvemonkeys/util/regex/WildcardStringParser.java | 1 + .../com/twelvemonkeys/imageio/path/AdobePathBuilder.java | 1 + .../com/twelvemonkeys/imageio/metadata/exif/EXIFReader.java | 1 + .../com/twelvemonkeys/imageio/metadata/exif/EXIFWriter.java | 1 + .../com/twelvemonkeys/imageio/metadata/exif/Rational.java | 1 + .../java/com/twelvemonkeys/imageio/metadata/exif/TIFF.java | 1 + .../main/java/com/twelvemonkeys/servlet/GenericFilter.java | 1 + .../src/main/java/com/twelvemonkeys/servlet/ServletUtil.java | 1 + .../main/java/com/twelvemonkeys/servlet/cache/HTTPCache.java | 5 +++-- .../java/com/twelvemonkeys/servlet/image/ImageFilter.java | 2 +- 15 files changed, 19 insertions(+), 3 deletions(-) diff --git a/common/common-image/src/main/java/com/twelvemonkeys/image/IndexImage.java b/common/common-image/src/main/java/com/twelvemonkeys/image/IndexImage.java index 2a359ca3..8afc933b 100755 --- a/common/common-image/src/main/java/com/twelvemonkeys/image/IndexImage.java +++ b/common/common-image/src/main/java/com/twelvemonkeys/image/IndexImage.java @@ -587,6 +587,7 @@ class IndexImage { * @deprecated Use {@link #getIndexColorModel(Image,int,int)} instead! * This version will be removed in a later version of the API. */ + @Deprecated public static IndexColorModel getIndexColorModel(Image pImage, int pNumberOfColors, boolean pFast) { return getIndexColorModel(pImage, pNumberOfColors, pFast ? COLOR_SELECTION_FAST : COLOR_SELECTION_QUALITY); } diff --git a/common/common-io/src/main/java/com/twelvemonkeys/io/FilenameMaskFilter.java b/common/common-io/src/main/java/com/twelvemonkeys/io/FilenameMaskFilter.java index 65e9e2de..ef0bed82 100755 --- a/common/common-io/src/main/java/com/twelvemonkeys/io/FilenameMaskFilter.java +++ b/common/common-io/src/main/java/com/twelvemonkeys/io/FilenameMaskFilter.java @@ -65,6 +65,7 @@ import java.io.FilenameFilter; * @see WildcardStringParser * @deprecated */ +@Deprecated public class FilenameMaskFilter implements FilenameFilter { // TODO: Rewrite to use regexp, or create new class diff --git a/common/common-io/src/main/java/com/twelvemonkeys/io/LittleEndianDataInputStream.java b/common/common-io/src/main/java/com/twelvemonkeys/io/LittleEndianDataInputStream.java index 2cb94a03..de045764 100755 --- a/common/common-io/src/main/java/com/twelvemonkeys/io/LittleEndianDataInputStream.java +++ b/common/common-io/src/main/java/com/twelvemonkeys/io/LittleEndianDataInputStream.java @@ -442,6 +442,7 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da * @see java.io.BufferedReader#readLine() * @see java.io.DataInputStream#readLine() */ + @Deprecated public String readLine() throws IOException { DataInputStream ds = new DataInputStream(in); return ds.readLine(); diff --git a/common/common-lang/src/main/java/com/twelvemonkeys/lang/StringUtil.java b/common/common-lang/src/main/java/com/twelvemonkeys/lang/StringUtil.java index 69979657..d1f88c93 100755 --- a/common/common-lang/src/main/java/com/twelvemonkeys/lang/StringUtil.java +++ b/common/common-lang/src/main/java/com/twelvemonkeys/lang/StringUtil.java @@ -770,6 +770,7 @@ public final class StringUtil { */ /*public*/ + @Deprecated static String formatNumber(long pNum, int pLen) throws IllegalArgumentException { StringBuilder result = new StringBuilder(); @@ -1464,6 +1465,7 @@ public final class StringUtil { */ /*public*/ + @Deprecated static String removeSubstring(final String pSource, final char pBeginBoundaryChar, final char pEndBoundaryChar, final int pOffset) { StringBuilder filteredString = new StringBuilder(); boolean insideDemarcatedArea = false; diff --git a/common/common-lang/src/main/java/com/twelvemonkeys/util/Time.java b/common/common-lang/src/main/java/com/twelvemonkeys/util/Time.java index a33fcd40..c793cae3 100755 --- a/common/common-lang/src/main/java/com/twelvemonkeys/util/Time.java +++ b/common/common-lang/src/main/java/com/twelvemonkeys/util/Time.java @@ -157,6 +157,7 @@ public class Time { * @see #parseTime(String) * @deprecated */ + @Deprecated public String toString(String pFormatStr) { TimeFormat tf = new TimeFormat(pFormatStr); @@ -174,6 +175,7 @@ public class Time { * @see #toString(String) * @deprecated */ + @Deprecated public static Time parseTime(String pStr) { TimeFormat tf = TimeFormat.getInstance(); diff --git a/common/common-lang/src/main/java/com/twelvemonkeys/util/regex/WildcardStringParser.java b/common/common-lang/src/main/java/com/twelvemonkeys/util/regex/WildcardStringParser.java index c13bf51e..3e3fc5a7 100755 --- a/common/common-lang/src/main/java/com/twelvemonkeys/util/regex/WildcardStringParser.java +++ b/common/common-lang/src/main/java/com/twelvemonkeys/util/regex/WildcardStringParser.java @@ -111,6 +111,7 @@ import java.io.PrintStream; * @author Eirik Torske * @deprecated Will probably be removed in the near future */ +@Deprecated public class WildcardStringParser { // TODO: Get rid of this class diff --git a/imageio/imageio-clippath/src/main/java/com/twelvemonkeys/imageio/path/AdobePathBuilder.java b/imageio/imageio-clippath/src/main/java/com/twelvemonkeys/imageio/path/AdobePathBuilder.java index 065fd864..682a753f 100755 --- a/imageio/imageio-clippath/src/main/java/com/twelvemonkeys/imageio/path/AdobePathBuilder.java +++ b/imageio/imageio-clippath/src/main/java/com/twelvemonkeys/imageio/path/AdobePathBuilder.java @@ -39,6 +39,7 @@ import java.io.IOException; * * @deprecated Use {@link AdobePathReader} instead. This class will be removed in a future release. */ +@Deprecated public final class AdobePathBuilder { private final AdobePathReader delegate; diff --git a/imageio/imageio-metadata/src/main/java/com/twelvemonkeys/imageio/metadata/exif/EXIFReader.java b/imageio/imageio-metadata/src/main/java/com/twelvemonkeys/imageio/metadata/exif/EXIFReader.java index fb417e8b..f877c8ec 100644 --- a/imageio/imageio-metadata/src/main/java/com/twelvemonkeys/imageio/metadata/exif/EXIFReader.java +++ b/imageio/imageio-metadata/src/main/java/com/twelvemonkeys/imageio/metadata/exif/EXIFReader.java @@ -46,6 +46,7 @@ import java.io.IOException; * * @deprecated Use com.twelvemonkeys.imageio.metadata.tiff.TIFFReader instead. */ +@Deprecated public final class EXIFReader extends MetadataReader { private final TIFFReader delegate = new TIFFReader(); diff --git a/imageio/imageio-metadata/src/main/java/com/twelvemonkeys/imageio/metadata/exif/EXIFWriter.java b/imageio/imageio-metadata/src/main/java/com/twelvemonkeys/imageio/metadata/exif/EXIFWriter.java index adb44b5d..82702519 100644 --- a/imageio/imageio-metadata/src/main/java/com/twelvemonkeys/imageio/metadata/exif/EXIFWriter.java +++ b/imageio/imageio-metadata/src/main/java/com/twelvemonkeys/imageio/metadata/exif/EXIFWriter.java @@ -48,6 +48,7 @@ import java.util.Collection; * * @deprecated Use com.twelvemonkeys.imageio.metadata.tiff.TIFFWriter instead. */ +@Deprecated public final class EXIFWriter extends MetadataWriter { private final TIFFWriter delegate = new TIFFWriter(); diff --git a/imageio/imageio-metadata/src/main/java/com/twelvemonkeys/imageio/metadata/exif/Rational.java b/imageio/imageio-metadata/src/main/java/com/twelvemonkeys/imageio/metadata/exif/Rational.java index b28847e5..12165ae5 100644 --- a/imageio/imageio-metadata/src/main/java/com/twelvemonkeys/imageio/metadata/exif/Rational.java +++ b/imageio/imageio-metadata/src/main/java/com/twelvemonkeys/imageio/metadata/exif/Rational.java @@ -41,6 +41,7 @@ package com.twelvemonkeys.imageio.metadata.exif; * * @deprecated Use com.twelvemonkeys.imageio.metadata.tiff.Rational instead. */ +@Deprecated public final class Rational extends Number implements Comparable { private final com.twelvemonkeys.imageio.metadata.tiff.Rational delegate; diff --git a/imageio/imageio-metadata/src/main/java/com/twelvemonkeys/imageio/metadata/exif/TIFF.java b/imageio/imageio-metadata/src/main/java/com/twelvemonkeys/imageio/metadata/exif/TIFF.java index 3a607fc8..5ef550fc 100644 --- a/imageio/imageio-metadata/src/main/java/com/twelvemonkeys/imageio/metadata/exif/TIFF.java +++ b/imageio/imageio-metadata/src/main/java/com/twelvemonkeys/imageio/metadata/exif/TIFF.java @@ -39,5 +39,6 @@ package com.twelvemonkeys.imageio.metadata.exif; * * @deprecated Use com.twelvemonkeys.imageio.metadata.tiff.TIFF instead. */ +@Deprecated public interface TIFF extends com.twelvemonkeys.imageio.metadata.tiff.TIFF { } diff --git a/servlet/src/main/java/com/twelvemonkeys/servlet/GenericFilter.java b/servlet/src/main/java/com/twelvemonkeys/servlet/GenericFilter.java index 1e68ab83..46f2e9f7 100755 --- a/servlet/src/main/java/com/twelvemonkeys/servlet/GenericFilter.java +++ b/servlet/src/main/java/com/twelvemonkeys/servlet/GenericFilter.java @@ -357,6 +357,7 @@ public abstract class GenericFilter implements Filter, FilterConfig, Serializabl * * @deprecated For compatibility only, use {@link #init init} instead. */ + @Deprecated @SuppressWarnings("UnusedDeclaration") public void setFilterConfig(final FilterConfig pFilterConfig) { try { diff --git a/servlet/src/main/java/com/twelvemonkeys/servlet/ServletUtil.java b/servlet/src/main/java/com/twelvemonkeys/servlet/ServletUtil.java index 5d72cff2..98390d83 100755 --- a/servlet/src/main/java/com/twelvemonkeys/servlet/ServletUtil.java +++ b/servlet/src/main/java/com/twelvemonkeys/servlet/ServletUtil.java @@ -337,6 +337,7 @@ public final class ServletUtil { * @deprecated Use {@link javax.servlet.http.HttpServletRequest#getRequestURL()} * instead. */ + @Deprecated static StringBuffer buildHTTPURL(final HttpServletRequest pRequest) { StringBuffer resultURL = new StringBuffer(); diff --git a/servlet/src/main/java/com/twelvemonkeys/servlet/cache/HTTPCache.java b/servlet/src/main/java/com/twelvemonkeys/servlet/cache/HTTPCache.java index 69676ea3..2055d3cf 100755 --- a/servlet/src/main/java/com/twelvemonkeys/servlet/cache/HTTPCache.java +++ b/servlet/src/main/java/com/twelvemonkeys/servlet/cache/HTTPCache.java @@ -271,9 +271,10 @@ public class HTTPCache { * cannot be created. * @deprecated Use {@link #HTTPCache(File, long, int, int, boolean)} instead. */ + @Deprecated public HTTPCache(final String pName, final ServletContext pContext, - final int pDefaultCacheExpiryTime, final int pMaxMemCacheSize, - final int pMaxCachedEntites, final boolean pDeleteCacheOnExit) { + final int pDefaultCacheExpiryTime, final int pMaxMemCacheSize, + final int pMaxCachedEntites, final boolean pDeleteCacheOnExit) { this( getTempFolder(pName, pContext), pDefaultCacheExpiryTime, pMaxMemCacheSize, pMaxCachedEntites, pDeleteCacheOnExit, diff --git a/servlet/src/main/java/com/twelvemonkeys/servlet/image/ImageFilter.java b/servlet/src/main/java/com/twelvemonkeys/servlet/image/ImageFilter.java index 1374910c..2b16e1c2 100755 --- a/servlet/src/main/java/com/twelvemonkeys/servlet/image/ImageFilter.java +++ b/servlet/src/main/java/com/twelvemonkeys/servlet/image/ImageFilter.java @@ -146,7 +146,7 @@ public abstract class ImageFilter extends GenericFilter { * @param pRequest the original request * @return the new response, or {@code pResponse} if the response is already wrapped * - * @see com.twelvemonkeys.servlet.image.ImageServletResponseWrapper + * @see com.twelvemonkeys.servlet.image.ImageServletResponseImpl */ private ImageServletResponse createImageServletResponse(final ServletRequest pRequest, final ServletResponse pResponse) { if (pResponse instanceof ImageServletResponseImpl) {