View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.cli2.validation;
18  
19  import java.util.List;
20  
21  /**
22   * The validation interface for validating argument values(s).
23   *
24   * A validator can replace the argument string value with a
25   * specific class instance e.g. the {@link UrlValidator} replaces
26   * the string value with a {@link java.net.URL} instance.
27   *
28   * @author Rob Oxspring
29   * @author John Keyes
30   */
31  public interface Validator {
32  
33      /**
34       * Validate the specified values (List of Strings).
35       *
36       * @param values The values to validate.
37       *
38       * @throws InvalidArgumentException If any of the
39       * specified values are not valid.
40       */
41      void validate(final List values) throws InvalidArgumentException;
42  
43  }