001/*
002 * Copyright 2019-2022 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2019-2022 Ping Identity Corporation
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *    http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020/*
021 * Copyright (C) 2019-2022 Ping Identity Corporation
022 *
023 * This program is free software; you can redistribute it and/or modify
024 * it under the terms of the GNU General Public License (GPLv2 only)
025 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
026 * as published by the Free Software Foundation.
027 *
028 * This program is distributed in the hope that it will be useful,
029 * but WITHOUT ANY WARRANTY; without even the implied warranty of
030 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
031 * GNU General Public License for more details.
032 *
033 * You should have received a copy of the GNU General Public License
034 * along with this program; if not, see <http://www.gnu.org/licenses>.
035 */
036package com.unboundid.ldap.sdk.transformations;
037
038
039
040import java.io.Serializable;
041
042import com.unboundid.ldap.sdk.Entry;
043import com.unboundid.util.NotMutable;
044import com.unboundid.util.NotNull;
045import com.unboundid.util.Nullable;
046import com.unboundid.util.ThreadSafety;
047import com.unboundid.util.ThreadSafetyLevel;
048
049
050
051/**
052 * This class provides an entry transformation that will simply suppress all
053 * entries.  It can be useful when processing a series of LDIF records if you
054 * only want to preserve change records and suppress all entries.
055 */
056@NotMutable()
057@ThreadSafety(level = ThreadSafetyLevel.COMPLETELY_THREADSAFE)
058public final class ExcludeAllEntriesTransformation
059       implements EntryTransformation, Serializable
060{
061  /**
062   * The serial version UID for this serializable class.
063   */
064  private static final long serialVersionUID = 8203086326365856962L;
065
066
067
068  /**
069   * Creates a new instance of this transformation.
070   */
071  public ExcludeAllEntriesTransformation()
072  {
073    // No implementation is required.
074  }
075
076
077
078  /**
079   * {@inheritDoc}
080   */
081  @Override()
082  @Nullable()
083  public Entry transformEntry(@NotNull final Entry entry)
084  {
085    return null;
086  }
087
088
089
090  /**
091   * {@inheritDoc}
092   */
093  @Override()
094  @Nullable()
095  public Entry translate(@NotNull final Entry original,
096                         final long firstLineNumber)
097  {
098    return null;
099  }
100
101
102
103  /**
104   * {@inheritDoc}
105   */
106  @Override()
107  @Nullable()
108  public Entry translateEntryToWrite(@NotNull final Entry original)
109  {
110    return null;
111  }
112}