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