com.unboundid.ldif.LDIFReaderEntryTranslator Maven / Gradle / Ivy
/*
* Copyright 2008-2021 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2008-2021 Ping Identity Corporation
*
* 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.
*/
/*
* Copyright (C) 2008-2021 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.ldif;
import com.unboundid.ldap.sdk.Entry;
import com.unboundid.util.Extensible;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
/**
* This interface is used by the LDIFReader to translate entries read from the
* input or filter them out before they are returned via
* {@link LDIFReader#readEntry}.
*/
@Extensible()
@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
public interface LDIFReaderEntryTranslator
{
/**
* Applies some special transformation or filtering to the original Entry.
*
* @param original The original Entry that was read and parsed from
* the input file.
* @param firstLineNumber The first line number of the LDIF record
* corresponding to the read Entry. This is most
* useful when throwing an LDIFException.
*
* @return The Entry that should be returned in the call to
* {@link LDIFReader#readEntry}. This can be the original parameter
* Entry, a newly constructed Entry, or {@code null} to signal that
* the provided Entry should be skipped.
*
* @throws LDIFException If there is an exception during processing. This
* exception will be re-thrown to the caller of
* readEntry.
*/
@Nullable()
Entry translate(@NotNull Entry original, long firstLineNumber)
throws LDIFException;
}