/* 
    P/P   *  Method: com.dmdirc.config.prefs.validator.FileNameValidator__static_init
          */
     1  /*
     2   * Copyright (c) 2006-2009 Chris Smith, Shane Mc Cormack, Gregory Holmes
     3   * 
     4   * Permission is hereby granted, free of charge, to any person obtaining a copy
     5   * of this software and associated documentation files (the "Software"), to deal
     6   * in the Software without restriction, including without limitation the rights
     7   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     8   * copies of the Software, and to permit persons to whom the Software is
     9   * furnished to do so, subject to the following conditions:
    10   * 
    11   * The above copyright notice and this permission notice shall be included in
    12   * all copies or substantial portions of the Software.
    13   * 
    14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    20   * SOFTWARE.
    21   */
    22  
    23  package com.dmdirc.config.prefs.validator;
    24  
    25  /**
    26   * Validates filenames.
    27   */
         /* 
    P/P   *  Method: ValidationResponse validate(Object)
          * 
          *  Preconditions:
          *    x0 != null
          * 
          *  Postconditions:
          *    return_value == One-of{&new ValidationResponse(validate#1*), &new ValidationResponse(validate#2*)}
          *    return_value in Addr_Set{&new ValidationResponse(validate#1*),&new ValidationResponse(validate#2*)}
          *    new ValidationResponse(validate#1*) num objects <= 1
          *    new ValidationResponse(validate#1*).failure == null
          *    new ValidationResponse(validate#2*) num objects <= 1
          *    new ValidationResponse(validate#2*).failure == &amp;"Must be a valid filename"
          */
    28  public class FileNameValidator implements Validator<String> {
    29  
    30      /** Filename regex. */
    31      private static final String FILENAME_REGEX = "[A-Za-z0-9 \\-_!]+";
    32      /** Failure reason. */
    33      private static final String FAILURE_REASON = "Must be a valid filename";
    34  
    35      /**
    36       * Instantiates a new filename validator.
    37       */
             /* 
    P/P       *  Method: void com.dmdirc.config.prefs.validator.FileNameValidator()
              */
    38      public FileNameValidator() {
    39          //Do nothing
    40      }
    41  
    42      /** {@inheritDoc} */
    43      @Override
    44      public ValidationResponse validate(final String object) {
                 /* 
    P/P           *  Method: ValidationResponse validate(String)
                  * 
                  *  Preconditions:
                  *    object != null
                  * 
                  *  Postconditions:
                  *    return_value in Addr_Set{&amp;new ValidationResponse(validate#2),&amp;new ValidationResponse(validate#1)}
                  *    new ValidationResponse(validate#1) num objects <= 1
                  *    new ValidationResponse(validate#1).failure == null
                  *    new ValidationResponse(validate#2) num objects <= 1
                  *    new ValidationResponse(validate#2).failure == &amp;"Must be a valid filename"
                  * 
                  *  Test Vectors:
                  *    java.lang.String:matches(...)@45: {0}, {1}
                  */
    45          if (object.matches(FILENAME_REGEX)) {
    46              return new ValidationResponse();
    47          } else {
    48              return new ValidationResponse(FAILURE_REASON);
    49          }
    50      }
    51  }