001/*
002 * Copyright 2015-2020 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2015-2020 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) 2015-2020 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.unboundidds.jsonfilter;
037
038
039
040import com.unboundid.util.StaticUtils;
041import com.unboundid.util.ThreadSafety;
042import com.unboundid.util.ThreadSafetyLevel;
043
044
045
046/**
047 * An enum that defines the possible values that may be used for the
048 * {@code expectedType} element of a {@link ContainsFieldJSONObjectFilter}.
049 * <BR>
050 * <BLOCKQUOTE>
051 *   <B>NOTE:</B>  This class, and other classes within the
052 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
053 *   supported for use against Ping Identity, UnboundID, and
054 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
055 *   for proprietary functionality or for external specifications that are not
056 *   considered stable or mature enough to be guaranteed to work in an
057 *   interoperable way with other types of LDAP servers.
058 * </BLOCKQUOTE>
059 */
060@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
061public enum ExpectedValueType
062{
063  /**
064   * Indicates that the target field may have a value of {@code true} or
065   * {@code false}.
066   */
067  BOOLEAN("boolean"),
068
069
070
071  /**
072   * Indicates that the target field may have a value that is an array
073   * containing zero elements.
074   */
075  EMPTY_ARRAY("empty-array"),
076
077
078
079  /**
080   * Indicates that the target field may have a value that is an array
081   * containing at least one element.  No restriction will be placed on the type
082   * of elements that may be held in the array.
083   */
084  NON_EMPTY_ARRAY("non-empty-array"),
085
086
087
088  /**
089   * Indicates that the target field may have a value of {@code null}.
090   * {@code null}.
091   */
092  NULL("null"),
093
094
095
096  /**
097   * Indicates that the target field may have a value that is a number.
098   */
099  NUMBER("number"),
100
101
102
103  /**
104   * Indicates that the target field may have a value that is a JSON object.
105   */
106  OBJECT("object"),
107
108
109
110  /**
111   * Indicates that the target field may have a value that is a string.
112   */
113  STRING("string");
114
115
116
117  // The name that should be used for the type.
118  private final String name;
119
120
121
122  /**
123   * Creates a new expected value type with the specified name.
124   *
125   * @param  name  The name for the type.
126   */
127  ExpectedValueType(final String name)
128  {
129    this.name = name;
130  }
131
132
133
134  /**
135   * Retrieves the expected value type with the specified name.
136   *
137   * @param  name  The name of the expected value type to retrieve.
138   *
139   * @return  The expected value type with the specified name, ro {@code null}
140   *          if there is no type with the given name.
141   */
142  public static ExpectedValueType forName(final String name)
143  {
144    switch (StaticUtils.toLowerCase(name))
145    {
146      case "boolean":
147        return BOOLEAN;
148      case "emptyarray":
149      case "empty-array":
150      case "empty_array":
151        return EMPTY_ARRAY;
152      case "nonemptyarray":
153      case "non-empty-array":
154      case "non_empty_array":
155        return NON_EMPTY_ARRAY;
156      case "null":
157        return NULL;
158      case "number":
159        return NUMBER;
160      case "object":
161        return OBJECT;
162      case "string":
163        return STRING;
164      default:
165        return null;
166    }
167  }
168
169
170
171  /**
172   * Retrieves a string representation of this expected value type.
173   *
174   * @return  A string representation of this expected value type.
175   */
176  @Override()
177  public String toString()
178  {
179    return name;
180  }
181}