You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by Gary Gregory <ga...@gmail.com> on 2017/06/12 20:37:53 UTC

Fwd: [1/4] [text] Deprecate CsvTranslators from from commons text in favor of Commons CSV

IMO it is not enough to @Deprecated a whole class. You need a @Deprecated
in the Javadoc with an explanation of what to replace it with. Like "Use
Foo#bar() in Apache Commons CSV".

Gary

---------- Forwarded message ----------
From: <ch...@apache.org>
Date: Mon, Jun 12, 2017 at 4:41 AM
Subject: [1/4] [text] Deprecate CsvTranslators from from commons text in
favor of Commons CSV
To: commits@commons.apache.org


Repository: commons-text
Updated Branches:
  refs/heads/master 640097555 -> 6a5fcfcba


Deprecate CsvTranslators from from commons text in favor of Commons CSV


Project: http://git-wip-us.apache.org/repos/asf/commons-text/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-text/commit/c9cfd335
Tree: http://git-wip-us.apache.org/repos/asf/commons-text/tree/c9cfd335
Diff: http://git-wip-us.apache.org/repos/asf/commons-text/diff/c9cfd335

Branch: refs/heads/master
Commit: c9cfd335f314e61a6c7f56cae4a4f818ffa5d75b
Parents: 343b4a9
Author: Amey Jadiye <am...@gmail.com>
Authored: Wed May 24 19:55:56 2017 +0530
Committer: Amey Jadiye <am...@gmail.com>
Committed: Wed May 24 19:55:56 2017 +0530

----------------------------------------------------------------------
 .../org/apache/commons/text/translate/CsvTranslators.java    | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-text/blob/
c9cfd335/src/main/java/org/apache/commons/text/translate/CsvTranslators.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/translate/CsvTranslators.java
b/src/main/java/org/apache/commons/text/translate/CsvTranslators.java
index a7a98e4..0c3c9c2 100644
--- a/src/main/java/org/apache/commons/text/translate/CsvTranslators.java
+++ b/src/main/java/org/apache/commons/text/translate/CsvTranslators.java
@@ -16,15 +16,15 @@
  */
 package org.apache.commons.text.translate;

-import org.apache.commons.lang3.CharUtils;
-import org.apache.commons.lang3.StringUtils;
-
 import java.io.IOException;
 import java.io.Writer;

+import org.apache.commons.lang3.CharUtils;
+import org.apache.commons.lang3.StringUtils;
 /**
  * This class holds inner classes for escaping/unescaping Comma Separated
Values.
  */
+@Deprecated
 public final class CsvTranslators {

     /** Comma character. */
@@ -45,6 +45,7 @@ public final class CsvTranslators {
     /**
      * Translator for escaping Comma Separated Values.
      */
+    @Deprecated
     public static class CsvEscaper extends SinglePassTranslator {

         @Override
@@ -64,6 +65,7 @@ public final class CsvTranslators {
     /**
      * Translator for unescaping escaped Comma Separated Value entries.
      */
+    @Deprecated
     public static class CsvUnescaper extends SinglePassTranslator {

         @Override

Re: [1/4] [text] Deprecate CsvTranslators from from commons text in favor of Commons CSV

Posted by Rob Tompkins <ch...@gmail.com>.

> On Jun 12, 2017, at 4:37 PM, Gary Gregory <ga...@gmail.com> wrote:
> 
> IMO it is not enough to @Deprecated a whole class. You need a @Deprecated
> in the Javadoc with an explanation of what to replace it with. Like "Use
> Foo#bar() in Apache Commons CSV".

That was a commit mid way through the discussion. The class at the HEAD of master should not have the deprecation in place. Do check me on that though. 

-Rob

> 
> Gary
> 
> ---------- Forwarded message ----------
> From: <ch...@apache.org>
> Date: Mon, Jun 12, 2017 at 4:41 AM
> Subject: [1/4] [text] Deprecate CsvTranslators from from commons text in
> favor of Commons CSV
> To: commits@commons.apache.org
> 
> 
> Repository: commons-text
> Updated Branches:
>  refs/heads/master 640097555 -> 6a5fcfcba
> 
> 
> Deprecate CsvTranslators from from commons text in favor of Commons CSV
> 
> 
> Project: http://git-wip-us.apache.org/repos/asf/commons-text/repo
> Commit: http://git-wip-us.apache.org/repos/asf/commons-text/commit/c9cfd335
> Tree: http://git-wip-us.apache.org/repos/asf/commons-text/tree/c9cfd335
> Diff: http://git-wip-us.apache.org/repos/asf/commons-text/diff/c9cfd335
> 
> Branch: refs/heads/master
> Commit: c9cfd335f314e61a6c7f56cae4a4f818ffa5d75b
> Parents: 343b4a9
> Author: Amey Jadiye <am...@gmail.com>
> Authored: Wed May 24 19:55:56 2017 +0530
> Committer: Amey Jadiye <am...@gmail.com>
> Committed: Wed May 24 19:55:56 2017 +0530
> 
> ----------------------------------------------------------------------
> .../org/apache/commons/text/translate/CsvTranslators.java    | 8 +++++---
> 1 file changed, 5 insertions(+), 3 deletions(-)
> ----------------------------------------------------------------------
> 
> 
> http://git-wip-us.apache.org/repos/asf/commons-text/blob/
> c9cfd335/src/main/java/org/apache/commons/text/translate/CsvTranslators.java
> ----------------------------------------------------------------------
> diff --git a/src/main/java/org/apache/commons/text/translate/CsvTranslators.java
> b/src/main/java/org/apache/commons/text/translate/CsvTranslators.java
> index a7a98e4..0c3c9c2 100644
> --- a/src/main/java/org/apache/commons/text/translate/CsvTranslators.java
> +++ b/src/main/java/org/apache/commons/text/translate/CsvTranslators.java
> @@ -16,15 +16,15 @@
>  */
> package org.apache.commons.text.translate;
> 
> -import org.apache.commons.lang3.CharUtils;
> -import org.apache.commons.lang3.StringUtils;
> -
> import java.io.IOException;
> import java.io.Writer;
> 
> +import org.apache.commons.lang3.CharUtils;
> +import org.apache.commons.lang3.StringUtils;
> /**
>  * This class holds inner classes for escaping/unescaping Comma Separated
> Values.
>  */
> +@Deprecated
> public final class CsvTranslators {
> 
>     /** Comma character. */
> @@ -45,6 +45,7 @@ public final class CsvTranslators {
>     /**
>      * Translator for escaping Comma Separated Values.
>      */
> +    @Deprecated
>     public static class CsvEscaper extends SinglePassTranslator {
> 
>         @Override
> @@ -64,6 +65,7 @@ public final class CsvTranslators {
>     /**
>      * Translator for unescaping escaped Comma Separated Value entries.
>      */
> +    @Deprecated
>     public static class CsvUnescaper extends SinglePassTranslator {
> 
>         @Override

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org