net.java.ao.schema.UnderscoreFieldNameConverter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of activeobjects Show documentation

This is the full Active Objects library, if you don't know which one to use, you probably want this one.

There is a newer version: 6.1.1

/*
 * Copyright 2007 Daniel Spiewak
 *
 * 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 net.java.ao.schema;

import java.util.List;
import java.util.Objects;

import static net.java.ao.schema.UnderScoreUtils.camelCaseToUnderScore;

/**
 * Imposes an underscore word-separation convention upon field names.
 * This will convert field in the following way:
 *
 * 
 * 
 * 
 * 
 * 
 * 
 *
 * 
 * 
 * 
 * 
 * 
 *
 * 
 * 
 * 
 * 
 * 
 *
 * 
 * 
 * 
 * 
 * 
 *
 * 
 * 
 * 
 * 
 * 
 * Method Name Returns Entity? Field Name
getFirstName false first_name
setLastName false last_name
getCompany true company_id
isCool false cool
 *
 * This converter allows for both all-lowercase and all-uppercase
 * field name conventions.  For example, depending on the configuration,
 * getLastName may convert to "LAST_NAME".
 *
 * This converter is all that is required to emulate the ActiveRecord
 * field name conversion.
 *
 * @author Daniel Spiewak
 */
public final class UnderscoreFieldNameConverter extends AbstractFieldNameConverter {
    private final Case fieldNameCase;

    /**
     * Creates a new field name converter in which all field names will
     * be either fully uppercase or fully lowercase.
     *
     * @param fieldNameCase the case to use for field names
     */
    public UnderscoreFieldNameConverter(Case fieldNameCase) {
        this.fieldNameCase = Objects.requireNonNull(fieldNameCase, "fieldNameCase can't be null");
    }

    public UnderscoreFieldNameConverter(Case fieldNameCase, List fieldNameResolvers) {
        super(fieldNameResolvers);
        this.fieldNameCase = Objects.requireNonNull(fieldNameCase, "fieldNameCase can't be null");
    }

    @Override
    public String convertName(String name) {
        return fieldNameCase.apply(camelCaseToUnderScore(name));
    }
}

Method Name	Returns Entity?	Field Name
getFirstName	`false`	first_name
setLastName	`false`	last_name
getCompany	`true`	company_id
isCool	`false`	cool