Re: [sca-assembly] [ASSEMBLY-197] Java classes do not follow standard capitalization in test classes - PROPOSAL

[Jim Marino <jim.marino@gmail.com>]

I have never seen a convention like this used, and it goes against recommendations spelled out very clearly in the JLS. If the goal is to be able to identify implementations, that can be done easily by simply appending an "Impl" suffix. Also, existing tools that I am aware of - e.g. IDEA IntelliJ - will display classes and implementations in different colors with specialized icons, presumably using the introspection facilities provide by the Java API. If those do not suffice, there is always the fallback to looking at the "class" and "interface" keywords in source. I therefore don't see how de-capitalizing implementation classes assists in identifying them.  

My initial reaction when I came across the naming scheme was that it was an error as it is foreign to anything I have seen in Java. I am sure I am not the only one that has made this assumption. 

I'm dismayed with the seeming intransigence on this issue as it is quite trivial to fix and makes the test cases look as if they were written by people not familiar with Java conventions. Similar to the package name discussions a while back, if OASIS is going to provide Java artifacts, it ought to adhere to recommendations made by the official Java language specification as opposed to inventing its own scheme.

 

Jim 

On Mar 10, 2010, at 1:43 PM, Mike Edwards wrote:

Folks,

This Issue indicates that the names of Java interfaces and Java classes do not follow "standard conventions"
for the names.

The actual convention followed is that
- service interface names start with a capital "S" - like Service1.java
- service implementation names start with a lower case "s" - like service1Impl.java

- implementations typically also have a suffix of "Impl"

This permits quick identification of service interfaces and their related implementations.


While this does not follow the "convention" for Java class naming, this is only a convention and is not any
kind of standard.  It does no harm and works well with existing toolsets.


I propose that ASSEMBLY 197 is Closed with No Action.



Yours,  Mike.

Strategist - Emerging Technologies, SCA & SDO.
Co Chair OASIS SCA Assembly TC.
IBM Hursley Park, Mail Point 146, Winchester, SO21 2JN, Great Britain.
Phone & FAX: +44-1962-818014    Mobile: +44-7802-467431  
Email:  mike_edwards@uk.ibm.com

---

Unless stated otherwise above:
IBM United Kingdom Limited - Registered in England and Wales with number 741598.
Registered office: PO Box 41, North Harbour, Portsmouth, Hampshire PO6 3AU