001/*
002 * Copyright 2009-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2009-2024 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) 2009-2024 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.util;
037
038
039
040/**
041 * This enum defines a set of output formats that may be used in conjunction
042 * with the {@link ColumnFormatter} when formatting data.
043 */
044@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
045public enum OutputFormat
046{
047  /**
048   * Indicates that the output should be formatted in columns.
049   */
050  COLUMNS,
051
052
053
054  /**
055   * Indicates that the output should be formatted as tab-delimited text.
056   */
057  TAB_DELIMITED_TEXT,
058
059
060
061  /**
062   * Indicates that the output should be formatted as comma-separated values.
063   */
064  CSV;
065
066
067
068  /**
069   * Retrieves the output format value with the specified name.
070   *
071   * @param  name  The name of the output format value to retrieve.  It must not
072   *               be {@code null}.
073   *
074   * @return  The requested output format value, or {@code null} if no such
075   *          format is defined.
076   */
077  @Nullable()
078  public static OutputFormat forName(@NotNull final String name)
079  {
080    switch (StaticUtils.toLowerCase(name))
081    {
082      case "columns":
083        return COLUMNS;
084      case "tabdelimitedtext":
085      case "tab-delimited-text":
086      case "tab_delimited_text":
087        return TAB_DELIMITED_TEXT;
088      case "csv":
089        return CSV;
090      default:
091        return null;
092    }
093  }
094}