001/*
002 * Copyright 2015-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2015-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) 2015-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.args;
037
038
039
040import java.io.Serializable;
041import java.util.regex.Pattern;
042
043import com.unboundid.util.Debug;
044import com.unboundid.util.NotMutable;
045import com.unboundid.util.NotNull;
046import com.unboundid.util.ThreadSafety;
047import com.unboundid.util.ThreadSafetyLevel;
048
049import static com.unboundid.util.args.ArgsMessages.*;
050
051
052
053/**
054 * This class provides an implementation of an argument value validator that is
055 * expected to be used with a string argument and ensures that all values for
056 * the argument are valid regular expressions.  Note that it does not verify
057 * that values match a given regular expression, but that can already be
058 * accomplished with the {@link StringArgument#setValueRegex} method.
059 */
060@NotMutable()
061@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
062public final class RegularExpressionArgumentValueValidator
063       extends ArgumentValueValidator
064       implements Serializable
065{
066  /**
067   * The serial version UID for this serializable class.
068   */
069  private static final long serialVersionUID = -6676584334684453380L;
070
071
072
073  /**
074   * Creates a new instance of this regular expression argument value validator.
075   */
076  public RegularExpressionArgumentValueValidator()
077  {
078    // No implementation is required.
079  }
080
081
082
083  /**
084   * {@inheritDoc}
085   */
086  @Override()
087  public void validateArgumentValue(@NotNull final Argument argument,
088                                    @NotNull final String valueString)
089         throws ArgumentException
090  {
091    try
092    {
093      Pattern.compile(valueString);
094    }
095    catch (final Exception e)
096    {
097      Debug.debugException(e);
098      throw new ArgumentException(
099           ERR_REGEX_VALIDATOR_VALUE_NOT_REGEX.get(valueString,
100                argument.getIdentifierString()),
101           e);
102    }
103  }
104
105
106
107  /**
108   * Retrieves a string representation of this argument value validator.
109   *
110   * @return  A string representation of this argument value validator.
111   */
112  @Override()
113  @NotNull()
114  public String toString()
115  {
116    final StringBuilder buffer = new StringBuilder();
117    toString(buffer);
118    return buffer.toString();
119  }
120
121
122
123  /**
124   * Appends a string representation of this argument value validator to the
125   * provided buffer.
126   *
127   * @param  buffer  The buffer to which the string representation should be
128   *                 appended.
129   */
130  public void toString(@NotNull final StringBuilder buffer)
131  {
132    buffer.append("RegularExpressionArgumentValueValidator()");
133  }
134}