1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.betwixt.strategy;
18
19 import java.util.Map;
20
21 import org.apache.commons.betwixt.ElementDescriptor;
22
23 /**
24 * A plugin Strategy pattern which will detect the plural property which
25 * maps to a singular property name.
26 * This Strategy is used when composite properties (such as properties
27 * of type Collection, List, Iterator, Enumeration) are used as we need to
28 * match the adder-method, which typically uses a singular name.
29 * This interface allows a variety of different implementations to be used.
30 *
31 * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
32 * @version $Revision: 438373 $
33 */
34 public interface PluralStemmer {
35
36 /**
37 * Find the plural descriptor for a singular property.
38 *
39 * @return the plural descriptor for the given singular property name
40 * or <code>null</code> is no matching descriptor can be found
41 * @param propertyName is the singular property name, from the adder method
42 * @param map is a map with the keys are the property names of the available
43 * descriptors and the values are the descriptors. This may not be null.
44 */
45 ElementDescriptor findPluralDescriptor( String propertyName, Map map );
46
47 }