You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@commons.apache.org by "Benjamin Bentmann (JIRA)" <ji...@apache.org> on 2008/07/26 13:05:31 UTC
[jira] Created: (EXEC-27) Rename EnvironmentUtil to
EnvironmentUtils
Rename EnvironmentUtil to EnvironmentUtils
------------------------------------------
Key: EXEC-27
URL: https://issues.apache.org/jira/browse/EXEC-27
Project: Commons Exec
Issue Type: Wish
Affects Versions: 1.0
Reporter: Benjamin Bentmann
Priority: Trivial
Utility classes from exec:
- {{DebugUtils}}
- {{MapUtils}}
- {{StringUtils}}
- {{EnvironmentUtil}}
Note that {{EnvironmentUtil}} is the only one using singular form of utility. To make the API consistent, both within exec and compared with other commons libs like collections and lang, I suggest to rename the class to {{EnvironmentUtils}}.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (EXEC-27) Rename EnvironmentUtil to
EnvironmentUtils
Posted by "Benjamin Bentmann (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/EXEC-27?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Benjamin Bentmann updated EXEC-27:
----------------------------------
Attachment: EXEC-27.patch
> Rename EnvironmentUtil to EnvironmentUtils
> ------------------------------------------
>
> Key: EXEC-27
> URL: https://issues.apache.org/jira/browse/EXEC-27
> Project: Commons Exec
> Issue Type: Wish
> Affects Versions: 1.0
> Reporter: Benjamin Bentmann
> Priority: Trivial
> Attachments: EXEC-27.patch
>
>
> Utility classes from exec:
> - {{DebugUtils}}
> - {{MapUtils}}
> - {{StringUtils}}
> - {{EnvironmentUtil}}
> Note that {{EnvironmentUtil}} is the only one using singular form of utility. To make the API consistent, both within exec and compared with other commons libs like collections and lang, I suggest to rename the class to {{EnvironmentUtils}}.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Issue Comment Edited: (EXEC-27) Rename EnvironmentUtil to
EnvironmentUtils
Posted by "Benjamin Bentmann (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/EXEC-27?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12647563#action_12647563 ]
bentmann edited comment on EXEC-27 at 11/14/08 2:27 AM:
-----------------------------------------------------------------
bq. nd I'm not really willing to break backward compatibility
Backward compat with what? The [project status|http://commons.apache.org/exec/] says "The code is unreleased."
bq. Regarding separation of public class and internal representation
Just let me explain why I feel it's worth/important to think about that. Over at Maven, they basically made everything public. Then some heavy redesign was due and in the effort to keep some backward-compat, they wonder why users are using so many of their internal but public classes... I'm admittedly naive, but there is a reason why Java provides different accessibility modes. The smaller the public/protected API, the easier to maintain it.
bq. I'm not too happy with structure [...] but I try to stick closely to the original ANT code simply because it is mature and known to work.
I don't see how refactoring, i.e. renaming/moving classes, can affect the stability. What better chance to clean up the API is there than before a library's first release? Anyway, it's your baby...
was (Author: bentmann):
bq. nd I'm not really willing to break backward compatibility
Backward compat with what? The [project status|http://commons.apache.org/exec/] says "The code is unreleased."
bq. I'm not too happy with structure [...] but I try to stick closely to the original ANT code simply because it is mature and known to work.
I don't see how refactoring, i.e. renaming/moving classes, can affect the stability. What better chance to clean up the API is there than before a library's first release? Anyway, it's your baby...
> Rename EnvironmentUtil to EnvironmentUtils
> ------------------------------------------
>
> Key: EXEC-27
> URL: https://issues.apache.org/jira/browse/EXEC-27
> Project: Commons Exec
> Issue Type: Wish
> Affects Versions: 1.0
> Reporter: Benjamin Bentmann
> Assignee: Siegfried Goeschl
> Priority: Trivial
> Attachments: EXEC-27.patch
>
>
> Utility classes from exec:
> - {{DebugUtils}}
> - {{MapUtils}}
> - {{StringUtils}}
> - {{EnvironmentUtil}}
> Note that {{EnvironmentUtil}} is the only one using singular form of utility. To make the API consistent, both within exec and compared with other commons libs like collections and lang, I suggest to rename the class to {{EnvironmentUtils}}.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (EXEC-27) Rename EnvironmentUtil to
EnvironmentUtils
Posted by "Siegfried Goeschl (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/EXEC-27?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12647568#action_12647568 ]
Siegfried Goeschl commented on EXEC-27:
---------------------------------------
Unreleased does not mean that is not out in the wild - it think it lived in the sandbox for three years. So in a way I'm forced to consider backward compatibility for an unreleased library.
> Rename EnvironmentUtil to EnvironmentUtils
> ------------------------------------------
>
> Key: EXEC-27
> URL: https://issues.apache.org/jira/browse/EXEC-27
> Project: Commons Exec
> Issue Type: Wish
> Affects Versions: 1.0
> Reporter: Benjamin Bentmann
> Assignee: Siegfried Goeschl
> Priority: Trivial
> Attachments: EXEC-27.patch
>
>
> Utility classes from exec:
> - {{DebugUtils}}
> - {{MapUtils}}
> - {{StringUtils}}
> - {{EnvironmentUtil}}
> Note that {{EnvironmentUtil}} is the only one using singular form of utility. To make the API consistent, both within exec and compared with other commons libs like collections and lang, I suggest to rename the class to {{EnvironmentUtils}}.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (EXEC-27) Rename EnvironmentUtil to
EnvironmentUtils
Posted by "Benjamin Bentmann (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/EXEC-27?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12647563#action_12647563 ]
Benjamin Bentmann commented on EXEC-27:
---------------------------------------
bq. nd I'm not really willing to break backward compatibility
Backward compat with what? The [project status|http://commons.apache.org/exec/] says "The code is unreleased."
bq. I'm not too happy with structure [...] but I try to stick closely to the original ANT code simply because it is mature and known to work.
I don't see how refactoring, i.e. renaming/moving classes, can affect the stability. What better chance to clean up the API is there than before a library's first release? Anyway, it's your baby...
> Rename EnvironmentUtil to EnvironmentUtils
> ------------------------------------------
>
> Key: EXEC-27
> URL: https://issues.apache.org/jira/browse/EXEC-27
> Project: Commons Exec
> Issue Type: Wish
> Affects Versions: 1.0
> Reporter: Benjamin Bentmann
> Assignee: Siegfried Goeschl
> Priority: Trivial
> Attachments: EXEC-27.patch
>
>
> Utility classes from exec:
> - {{DebugUtils}}
> - {{MapUtils}}
> - {{StringUtils}}
> - {{EnvironmentUtil}}
> Note that {{EnvironmentUtil}} is the only one using singular form of utility. To make the API consistent, both within exec and compared with other commons libs like collections and lang, I suggest to rename the class to {{EnvironmentUtils}}.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (EXEC-27) Rename EnvironmentUtil to
EnvironmentUtils
Posted by "Siegfried Goeschl (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/EXEC-27?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12647561#action_12647561 ]
Siegfried Goeschl commented on EXEC-27:
---------------------------------------
The EnvironmentUtil class is part of the original code drop, all other *Utils I wrote. And I'm not really willing to break backward compatibility due to cosmetic name change.
Regarding separation of public class and internal representation
+) no one is reading javadoc to understand such a fine-grained separation between public classes and useful implementation classes
+) to cleanly separate it I personally would create an "impl" package but this is not really an option
As a side note: I'm not too happy with structure and some implementation decisions but I try to stick closely to the original ANT code simply because it is mature and known to work. And retesting the code on the various platforms is a major headache .... :-)
> Rename EnvironmentUtil to EnvironmentUtils
> ------------------------------------------
>
> Key: EXEC-27
> URL: https://issues.apache.org/jira/browse/EXEC-27
> Project: Commons Exec
> Issue Type: Wish
> Affects Versions: 1.0
> Reporter: Benjamin Bentmann
> Assignee: Siegfried Goeschl
> Priority: Trivial
> Attachments: EXEC-27.patch
>
>
> Utility classes from exec:
> - {{DebugUtils}}
> - {{MapUtils}}
> - {{StringUtils}}
> - {{EnvironmentUtil}}
> Note that {{EnvironmentUtil}} is the only one using singular form of utility. To make the API consistent, both within exec and compared with other commons libs like collections and lang, I suggest to rename the class to {{EnvironmentUtils}}.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Resolved: (EXEC-27) Rename EnvironmentUtil to
EnvironmentUtils
Posted by "Siegfried Goeschl (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/EXEC-27?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Siegfried Goeschl resolved EXEC-27.
-----------------------------------
Resolution: Fixed
Fix Version/s: 1.0
Finally decided to do the change since I hat inconsistencies - small possibility that it break existing clients.
> Rename EnvironmentUtil to EnvironmentUtils
> ------------------------------------------
>
> Key: EXEC-27
> URL: https://issues.apache.org/jira/browse/EXEC-27
> Project: Commons Exec
> Issue Type: Wish
> Affects Versions: 1.0
> Reporter: Benjamin Bentmann
> Assignee: Siegfried Goeschl
> Priority: Trivial
> Fix For: 1.0
>
> Attachments: EXEC-27.patch
>
>
> Utility classes from exec:
> - {{DebugUtils}}
> - {{MapUtils}}
> - {{StringUtils}}
> - {{EnvironmentUtil}}
> Note that {{EnvironmentUtil}} is the only one using singular form of utility. To make the API consistent, both within exec and compared with other commons libs like collections and lang, I suggest to rename the class to {{EnvironmentUtils}}.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (EXEC-27) Rename EnvironmentUtil to
EnvironmentUtils
Posted by "Benjamin Bentmann (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/EXEC-27?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12617157#action_12617157 ]
Benjamin Bentmann commented on EXEC-27:
---------------------------------------
Related note: The classes {{DefaultProcessingEnvironment}} and {{OpenVmsProcessingEnvironment}} are according to their API docs "helper classes". If these are not meant to be helpers for the client but rather implementation helpers, maybe add a warning to the javadoc or preferrably reduce their visibility to package/default to exclude them from the public API?
> Rename EnvironmentUtil to EnvironmentUtils
> ------------------------------------------
>
> Key: EXEC-27
> URL: https://issues.apache.org/jira/browse/EXEC-27
> Project: Commons Exec
> Issue Type: Wish
> Affects Versions: 1.0
> Reporter: Benjamin Bentmann
> Priority: Trivial
> Attachments: EXEC-27.patch
>
>
> Utility classes from exec:
> - {{DebugUtils}}
> - {{MapUtils}}
> - {{StringUtils}}
> - {{EnvironmentUtil}}
> Note that {{EnvironmentUtil}} is the only one using singular form of utility. To make the API consistent, both within exec and compared with other commons libs like collections and lang, I suggest to rename the class to {{EnvironmentUtils}}.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.