001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau;
014
015import org.apache.juneau.annotation.*;
016
017/**
018 * Defines an API for converting conventional bean property names to some other form.
019 *
020 * <p>
021 * For example, given the bean property <js>"fooBarURL"</js>, the {@link PropertyNamerDLC} property namer will convert
022 * this to <js>"foo-bar-url"</js>.
023 *
024 * <p>
025 * Property namers are associated with beans through the {@link Bean#propertyNamer @Bean(propertyNamer)} annotation.
026 *
027 * <h5 class='section'>See Also:</h5><ul>
028
029 * </ul>
030 */
031public interface PropertyNamer {
032
033   /**
034    * Represents a non-existent class.
035    */
036   public interface Void extends PropertyNamer {}
037
038   /**
039    * Convert the specified default property name to some other value.
040    *
041    * @param name The original bean property name.
042    * @return The converted property name.
043    */
044   String getPropertyName(String name);
045}