com.unboundid.ldif.TrailingSpaceBehavior Maven / Gradle / Ivy
/*
* Copyright 2012-2021 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2012-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) 2012-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.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.StaticUtils;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
/**
* This enum defines a set of possible behaviors that may be exhibited by the
* LDIF reader when encountering trailing spaces in attribute values that are
* not base64-encoded.
*/
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public enum TrailingSpaceBehavior
{
/**
* Indicates that illegal trailing spaces should be silently stripped from
* attribute values.
*/
STRIP,
/**
* Indicates that illegal trailing spaces should be retained (as if the value
* had been base64-encoded).
*/
RETAIN,
/**
* Indicates that illegal trailing spaces should cause the associated entry to
* be rejected.
*/
REJECT;
/**
* Retrieves the trailing space behavior with the specified name.
*
* @param name The name of the trailing space behavior to retrieve. It must
* not be {@code null}.
*
* @return The requested trailing space behavior, or {@code null} if no such
* behavior is defined.
*/
@Nullable()
public static TrailingSpaceBehavior forName(@NotNull final String name)
{
switch (StaticUtils.toLowerCase(name))
{
case "strip":
return STRIP;
case "retain":
return RETAIN;
case "reject":
return REJECT;
default:
return null;
}
}
}