001/*
002 * Copyright 2012-2022 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2012-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) 2012-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.ldif;
037
038
039
040import com.unboundid.util.NotNull;
041import com.unboundid.util.Nullable;
042import com.unboundid.util.StaticUtils;
043import com.unboundid.util.ThreadSafety;
044import com.unboundid.util.ThreadSafetyLevel;
045
046
047
048/**
049 * This enum defines a set of possible behaviors that may be exhibited by the
050 * LDIF reader when encountering entries with duplicate attribute values.
051 */
052@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
053public enum DuplicateValueBehavior
054{
055  /**
056   * Indicates that duplicate values should be stripped, so that the resulting
057   * entry will have only one copy of the value.
058   */
059  STRIP,
060
061
062
063  /**
064   * Indicates that duplicate values should be retained, so that the resulting
065   * entry may have multiple copies of the value.  This is illegal and may cause
066   * significant problems with attempts to use the resulting entry.
067   */
068  RETAIN,
069
070
071
072  /**
073   * Indicates that any entry containing duplicate attribute values should be
074   * rejected.
075   */
076  REJECT;
077
078
079
080  /**
081   * Retrieves the duplicate value behavior with the specified name.
082   *
083   * @param  name  The name of the duplicate value behavior to retrieve.  It
084   *               must not be {@code null}.
085   *
086   * @return  The requested duplicate value behavior, or {@code null} if no such
087   *          behavior is defined.
088   */
089  @Nullable()
090  public static DuplicateValueBehavior forName(@NotNull final String name)
091  {
092    switch (StaticUtils.toLowerCase(name))
093    {
094      case "strip":
095        return STRIP;
096      case "retain":
097        return RETAIN;
098      case "reject":
099        return REJECT;
100      default:
101        return null;
102    }
103  }
104}