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