com.viiyue.plugins.mybatis.enums.NameStyle Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mybatis-mapper Show documentation

Mybatis generic mapper plugin for solving most basic operations, simplifying sql syntax and improving dynamic execution efficiency

There is a newer version: 1.3.7

Show newest version

/**
 * Copyright (C) 2017 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.viiyue.plugins.mybatis.enums;

import java.util.Locale;

import com.viiyue.plugins.mybatis.utils.CaseUtil;

/**
 * Conversion style between model bean property name and database field name
 *
 * 
 * {@link NameStyle#DEFAULT DEFAULT} - the original attribute name
 * 
{@link NameStyle#UPPERCASE UPPERCASE} - convert attribute names to all uppercase characters
 * 
{@link NameStyle#LOWERCASE LOWERCASE} - convert attribute names to all lowercase characters
 * 
{@link NameStyle#UNDERLINE UNDERLINE} - attribute names are converted to underscores to separate words
 * 
{@link NameStyle#UNDERLINE_UPPERCASE UNDERLINE_UPPERCASE} - convert attribute names to uppercase words separated by underscores
 * 
 *
 * @author tangxbai
 * @since 1.0.0
 */
public enum NameStyle {

	/**
	 * The default style,
	 * If it is on the field, the original field name is used by default. 
	 * If it appears in the Table, the name style marked on the class is used by default.
	 */
	DEFAULT,

	/**
	 * Convert to all uppercase text
	 */
	UPPERCASE {
		@Override
		public String convert( String property ) {
			return property.toUpperCase( Locale.ENGLISH );
		}
	},

	/**
	 * Convert to all lowercase text
	 */
	LOWERCASE {
		@Override
		public String convert( String property ) {
			return property.toLowerCase( Locale.ENGLISH );
		}
	},

	/**
	 * Convert to underlined text
	 */
	UNDERLINE {
		@Override
		public String convert( String property ) {
			return CaseUtil.toUnderscore( property );
		}
	},

	/**
	 * Convert all uppercase text separated by underscores
	 */
	UNDERLINE_UPPERCASE {
		@Override
		public String convert( String property ) {
			return CaseUtil.toUnderscore( property ).toUpperCase();
		}
	};

	/**
	 * Value convert with different style
	 * 
	 * @param property target propery name
	 * @return converted property name
	 */
	public String convert( String property ) {
		return property;
	}

}