org.springframework.batch.item.ldif.RecordMapper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-batch-infrastructure Show documentation
Show all versions of spring-batch-infrastructure Show documentation
The Spring Batch Infrastructure is a set of
low-level components, interfaces and tools for batch processing
applications and optimisations
/*
* Copyright 2005-2018 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
*
* https://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.springframework.batch.item.ldif;
import org.springframework.lang.Nullable;
import org.springframework.ldap.core.LdapAttributes;
/**
* This interface should be implemented to map {@link LdapAttributes LdapAttributes}
* objects to POJOs. The resulting implementations can be used in the
* {@link MappingLdifReader MappingLdifReader}.
*
* @author Keith Barlow
* @author Mahmoud Ben Hassine
* @param type the record will be mapped to
*/
public interface RecordMapper {
/**
* Maps an {@link LdapAttributes LdapAttributes} object to the specified type.
* @param attributes attributes
* @return object of type T or {@code null} if unable to map the record to an object.
*/
@Nullable
T mapRecord(LdapAttributes attributes);
}