001/*
002 * Copyright 2005-2018 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.springframework.batch.item.ldif;
017
018import org.springframework.lang.Nullable;
019import org.springframework.ldap.core.LdapAttributes;
020
021/**
022 * This interface should be implemented to map {@link LdapAttributes LdapAttributes} objects to POJOs. The resulting
023 * implementations can be used in the {@link MappingLdifReader MappingLdifReader}.
024 *
025 * @author Keith Barlow
026 * @author Mahmoud Ben Hassine
027 *
028 * @param <T> type the record will be mapped to
029 */
030public interface RecordMapper<T> {
031
032        /**
033         * Maps an {@link LdapAttributes LdapAttributes} object to the specified type.
034         *
035         * @param attributes attributes
036         * @return object of type T or {@code null} if unable to map the record to
037         * an object.
038         */
039        @Nullable
040        T mapRecord(LdapAttributes attributes);
041
042}