/*
 * 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 org.jdbi.v3.core.mapper.reflect;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

import org.jdbi.v3.core.config.JdbiConfig;

Configuration class for reflective mappers.
/** * Configuration class for reflective mappers. */
public class ReflectionMappers implements JdbiConfig<ReflectionMappers> { private List<ColumnNameMatcher> columnNameMatchers; private boolean strictMatching;
Create a default configuration that attempts case insensitive and snake_case matching for names.
/** * Create a default configuration that attempts case insensitive and * snake_case matching for names. */
public ReflectionMappers() { columnNameMatchers = Arrays.asList( new CaseInsensitiveColumnNameMatcher(), new SnakeCaseColumnNameMatcher()); strictMatching = false; } private ReflectionMappers(ReflectionMappers that) { columnNameMatchers = new ArrayList<>(that.columnNameMatchers); strictMatching = that.strictMatching; }
Returns:the registered column name mappers
/** * @return the registered column name mappers */
public List<ColumnNameMatcher> getColumnNameMatchers() { return Collections.unmodifiableList(columnNameMatchers); }
Replace all column name matchers with the given list.
Params:
  • columnNameMatchers – the column name matchers to use
Returns:this
/** * Replace all column name matchers with the given list. * @param columnNameMatchers the column name matchers to use * @return this */
public ReflectionMappers setColumnNameMatchers(List<ColumnNameMatcher> columnNameMatchers) { this.columnNameMatchers = new ArrayList<>(columnNameMatchers); return this; }
Returns:if strict column name matching is enabled
/** * @return if strict column name matching is enabled */
public boolean isStrictMatching() { return this.strictMatching; }
Throw an IllegalArgumentException if a the set of fields doesn't match to columns exactly. Reflection mappers with prefixes will only check those columns that begin with the mapper's prefix.
Params:
  • strictMatching – whether to enable strict matching
Returns:this
/** * Throw an IllegalArgumentException if a the set of fields doesn't * match to columns exactly. * * Reflection mappers with prefixes will only check those columns that * begin with the mapper's prefix. * * @param strictMatching whether to enable strict matching * @return this */
public ReflectionMappers setStrictMatching(boolean strictMatching) { this.strictMatching = strictMatching; return this; } @Override public ReflectionMappers createCopy() { return new ReflectionMappers(this); } }