[LANG-696] Update documentation and tests related to ClassUtils getShortClassName and getSimpleName

• Type: New Feature
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.6
• Fix Version/s: 3.10
• Component/s: lang.*
• Assignee: Gary D. Gregory
• Reporter: Gary D. Gregory
• Created: 21/Apr/11 15:27
• Updated: 05/Oct/24 13:53
• Resolved: 05/Oct/24 13:53

Description

Added two null-safe ClassUtils.getSimpleName() APIs.

---------- Forwarded message ----------
From: Gary Gregory <[e-mail]>
Date: Mon, Apr 11, 2011 at 10:18 AM
Subject: [Lang] ClassUtils getShortClassName != Class getSimpleName
To: Commons Developers List <[e-mail]>

Hi All:

Should we deprecate ClassUtils getShortClassName in favor of Class getSimpleName?

The behavior of getShortClassName is undocumented for arrays in the Javadoc and is different from getSimpleName.

When I replace the guts of getShortClassName to call getSimpleName, one test fails:

junit.framework.ComparisonFailure: null expected:<[ToStringStyleTest.]Person[name=John Q. ...> but was:<[]Person[name=John Q. ...>
at junit.framework.Assert.assertEquals(Assert.java:81)
at junit.framework.Assert.assertEquals(Assert.java:87)
at org.apache.commons.lang3.builder.ShortPrefixToStringStyleTest.testPerson(ShortPrefixToStringStyleTest.java:86)

For now, I've made a note in the Javdoc to consider using getSimpleName.

Issue Links

• links to: GitHub Pull Request #449