com.cedarsoftware.io.reflect.InjectorFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of json-io Show documentation

Java JSON serialization

There is a newer version: 4.9.8

package com.cedarsoftware.io.reflect;

import java.lang.reflect.Field;
import java.util.Map;

/**
 * @author Kenny Partlow ([email protected])
 *         

 *         Copyright (c) Cedar Software LLC
 *         


 *         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
 *         


 *         License
 *         


 *         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.
 */
public interface InjectorFactory {

    /**
     * Creates accessors for accessing data from an object.
     *
     * @param field           The field we're trying to access
     * @param nonStandardNames a map of possible methods from the class itself
     * @param uniqueName a uniqueName to use as a key in map if the class has two methods with same name.
     * @return The accessor if one fits for this field, otherwise null.
     */
    Injector createInjector(Field field, Map, Map> nonStandardNames, String uniqueName);

    /**
     * Retrieves the mapping for the specified class and field name.
     *
     * @param classToMapping the map containing class-to-mapping associations
     * @param c the class for which to retrieve the mapping
     * @param fieldName the field name for which to retrieve the mapping
     * @return the mapped value, or {@code null} if no mapping exists for the class or field name
     */
    default String getMapping(Map, Map> classToMapping, Class c, String fieldName) {
        Map mapping = classToMapping.get(c);
        return (mapping != null) ? mapping.get(fieldName) : null;
    }
}