OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

sca-assembly message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


Subject: Re: [sca-assembly] [ISSUE 197]: Java classes do not follow standardcapitalization



Folks,

Just to explain the current design that I have followed for the Java artifacts in the Assembly test suite:

I decided to distinguish the Interface classes from the Implementation classes.
Interface classes start with a capital letter, eg. Service1.java
Implementation classes start with a lower case letter - and typically start with the name of the interface
which they provide as a service, eg service1Impl2.java

You may not like this convention that I've adopted, but I have found it useful when working on the test
suite.

I suppose that other conventions are possible to enable a quick visual distinction between interfaces
and implementations, such as an initial capital "I" for interfaces.  Proposals welcome.


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



From: Jim Marino <jim.marino@gmail.com>
To: OASIS Assembly <sca-assembly@lists.oasis-open.org>
Date: 12/01/2010 15:44
Subject: Re: [sca-assembly] NEW ISSUE:  Java classes do not follow standard capitalization





There are a number of classes in the General_Java contribution, e.g.  
org.oasisopen.sca.test.service1Impl,  
org.oasisopen.sca.test.service1Impl3, etc.

While these names are syntactically valid, the Java Language  
Specification recommends otherwise. Section 6.8 of the JLS (Second  
Edition), Naming Conventions, states:

"Names of class types should be descriptive nouns or noun phrases, not  
overly long, in mixed case with the first letter of each word  
capitalized."

Jim

P.S. Please note if you try and rename the files locally and commit  
through Subversion, the latter is likely to throw an error as it does  
not handle case changes well (this will happen with Unix systems, I  
don't know what will happen with Windows systems). The changes need to  
be done directly against the Subversion repository.

On Jan 12, 2010, at 2:11 PM, David Booz wrote:

> Which testcase is an example of this problem? Can someone point me  
> to the
> standard where the correct usage is defined?  I was not aware of  
> such a
> standard.
>
> Dave Booz
> STSM, BPM and SCA Architecture
> Co-Chair OASIS SCA-Policy TC and SCA-J TC
> "Distributed objects first, then world hunger"
> Poughkeepsie, NY (845)-435-6093  or  8-295-6093
> e-mail:booz@us.ibm.com
>
>
> |------------>
> | From:      |
> |------------>
>> --------------------------------------------------------------------------------------------------------------------------------------------------|
>  |Mike Edwards  
> <
> mike_edwards
> @uk
> .ibm
> .com
> >
>                                                                                                             |
>> --------------------------------------------------------------------------------------------------------------------------------------------------|
> |------------>
> | To:        |
> |------------>
>> --------------------------------------------------------------------------------------------------------------------------------------------------|
>  |OASIS Assembly <sca-assembly@lists.oasis-
> open
> .org
> >
>                                                                                                 |
>> --------------------------------------------------------------------------------------------------------------------------------------------------|
> |------------>
> | Date:      |
> |------------>
>> --------------------------------------------------------------------------------------------------------------------------------------------------|
>  |01/12/2010 04:08  
> AM
>                                                                                                                                |
>> --------------------------------------------------------------------------------------------------------------------------------------------------|
> |------------>
> | Subject:   |
> |------------>
>> --------------------------------------------------------------------------------------------------------------------------------------------------|
>  |Re: [sca-assembly] NEW ISSUE:  Java classes do not follow standard  
> capitalization
>                                                                  |
>> --------------------------------------------------------------------------------------------------------------------------------------------------|
>
>
>
>
>
>
> Logged as:
http://www.osoa.org/jira/browse/ASSEMBLY-197
>
> 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
>
>
> From:   Jim Marino <jim.marino@gmail.com>
>
> To:     OASIS Assembly <sca-assembly@lists.oasis-open.org>
>
> Date:   11/01/2010 18:16
>
> Subject [sca-assembly] NEW ISSUE:  Java classes do not follow standard
> :       capitalization
>
>
>
>
>
>
>
> NEW ISSUE:   Java classes do not follow standard capitalization.
>
> TARGET: SCA Assembly Conformance Tests
>
> DESCRIPTION:
>
> Many Java test classes do not follow the standard Java capitalization
> scheme.
>
> PROPOSAL:
>
> Rename the classes. Since Subversion has problems with local  
> modifications
> and capitalization, files will need to be renamed directly in the repo
> instead of through a check-in of local modifications.
>
>
>
>
>
>
>
>
>
> 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
>
>
>
>
>
>
>
>
>
>
>
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe from this mail list, you must leave the OASIS TC that
> generates this mail.  Follow this link to all your TCs in OASIS at:
>
https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php
>


---------------------------------------------------------------------
To unsubscribe from this mail list, you must leave the OASIS TC that
generates this mail.  Follow this link to all your TCs in OASIS at:
https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php









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








[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]