View Javadoc

1   /*
2    * Copyright 2006 Outsource Cafe, Inc.
3    *
4    * Licensed under the Apache License, Version 2.0 (the 'License')
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *    http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an 'AS IS' BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.javagen.agile.oo.naming;
17  
18  /***
19   * Try to convert singular nouns to plural nouns and back again.
20   * This allows using good grammer in naming properties and references
21   * with regard to cardinality.
22   *
23   * @author Richard Easterling
24   */
25  public interface Pluralisation {
26  
27      /***
28       * Takes a case-sensitive name and makes it singular.  
29       * This method preserves camel-back naming conventions generally used 
30       * with class names.  Thus input names may need to be converted to be
31       * recognized.
32       */
33      String toSingular(String plural);
34      
35      /***
36       * Takes a case-sensitive name and makes it plural. 
37       */
38      String toPlural(String singular);
39  
40  }