You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@commons.apache.org by "Paul Benedict (JIRA)" <ji...@apache.org> on 2007/10/30 22:05:50 UTC

[jira] Created: (LANG-371) ToStringStyle javadoc should show examples of styles

ToStringStyle javadoc should show examples of styles
----------------------------------------------------

                 Key: LANG-371
                 URL: https://issues.apache.org/jira/browse/LANG-371
             Project: Commons Lang
          Issue Type: Improvement
            Reporter: Paul Benedict
            Priority: Trivial
             Fix For: 2.4


It is impossible to know what the style types actually render without seeing an example. I recommend first showing the code of a simple object, then give each constant an output example.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (LANG-371) ToStringStyle javadoc should show examples of styles

Posted by "Henri Yandell (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/LANG-371?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12539898 ] 

Henri Yandell commented on LANG-371:
------------------------------------

Looks good - patch applied (r591559).

Before closing this issue, I think we should also add the examples to the unit tests.

> ToStringStyle javadoc should show examples of styles
> ----------------------------------------------------
>
>                 Key: LANG-371
>                 URL: https://issues.apache.org/jira/browse/LANG-371
>             Project: Commons Lang
>          Issue Type: Improvement
>            Reporter: Paul Benedict
>            Priority: Trivial
>             Fix For: 2.4
>
>         Attachments: patch.txt
>
>
> It is impossible to know what the style types actually render without seeing an example. I recommend first showing the code of a simple object, then give each constant an output example.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (LANG-371) ToStringStyle javadoc should show examples of styles

Posted by "Scott Bassin (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/LANG-371?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Scott Bassin updated LANG-371:
------------------------------

    Attachment: patch.txt

Here's a patch where I document each constant using the example of the hypothetical Person class found in the ToStringBuilder javadoc.

> ToStringStyle javadoc should show examples of styles
> ----------------------------------------------------
>
>                 Key: LANG-371
>                 URL: https://issues.apache.org/jira/browse/LANG-371
>             Project: Commons Lang
>          Issue Type: Improvement
>            Reporter: Paul Benedict
>            Priority: Trivial
>             Fix For: 2.4
>
>         Attachments: patch.txt
>
>
> It is impossible to know what the style types actually render without seeing an example. I recommend first showing the code of a simple object, then give each constant an output example.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (LANG-371) ToStringStyle javadoc should show examples of styles

Posted by "Scott Bassin (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/LANG-371?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Scott Bassin updated LANG-371:
------------------------------

    Attachment: patch.txt

I've added a static Person class to ToStringStyleTest and added tests to:

DefaultToStringStyleTest, MultiLineToStringStyleTest, NoFieldNamesToStringStyleTest, ShortPrefixToStringStyleTest, SimpleToStringStyleTest, and StandardToStringStyleTest.

Is this what you had in mind, Henri?

> ToStringStyle javadoc should show examples of styles
> ----------------------------------------------------
>
>                 Key: LANG-371
>                 URL: https://issues.apache.org/jira/browse/LANG-371
>             Project: Commons Lang
>          Issue Type: Improvement
>            Reporter: Paul Benedict
>            Priority: Trivial
>             Fix For: 2.4
>
>         Attachments: patch.txt, patch.txt
>
>
> It is impossible to know what the style types actually render without seeing an example. I recommend first showing the code of a simple object, then give each constant an output example.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Closed: (LANG-371) ToStringStyle javadoc should show examples of styles

Posted by "Henri Yandell (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/LANG-371?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Henri Yandell closed LANG-371.
------------------------------

    Resolution: Fixed

Patch applied (r592643) - many thanks Scott, all these patches are an enormous help.

> ToStringStyle javadoc should show examples of styles
> ----------------------------------------------------
>
>                 Key: LANG-371
>                 URL: https://issues.apache.org/jira/browse/LANG-371
>             Project: Commons Lang
>          Issue Type: Improvement
>            Reporter: Paul Benedict
>            Priority: Trivial
>             Fix For: 2.4
>
>         Attachments: patch.txt, patch.txt
>
>
> It is impossible to know what the style types actually render without seeing an example. I recommend first showing the code of a simple object, then give each constant an output example.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.