de.unentscheidbar.validation.builtin.FileNameValidator.java Source code

Introduction

Here is the source code for de.unentscheidbar.validation.builtin.FileNameValidator.java

Source

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2009 Sun Microsystems, Inc. All rights reserved. Portions Copyrighted 2012 Daniel
 * Huss.
 * 
 * The contents of this file are subject to the terms of either the GNU General Public License
 * Version 2 only ("GPL") or the Common Development and Distribution License("CDDL") (collectively,
 * the "License"). You may not use this file except in compliance with the License. You can obtain a
 * copy of the License at http://www.netbeans.org/cddl-gplv2.html or nbbuild/licenses/CDDL-GPL-2-CP.
 * See the License for the specific language governing permissions and limitations under the
 * License. When distributing the software, include this License Header Notice in each file and
 * include the License file at nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this particular file
 * as subject to the "Classpath" exception as provided by Sun in the GPL Version 2 section of the
 * License file that accompanied this code. If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * The Original Software is NetBeans. The Initial Developer of the Original Software is Sun
 * Microsystems, Inc. Portions Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
 * 
 * If you wish your version of this file to be governed by only the CDDL or only the GPL Version 2,
 * indicate your decision by adding "[Contributor] elects to include this software in this
 * distribution under the [CDDL or GPL Version 2] license." If you do not indicate a single choice
 * of license, a recipient has the option to distribute your version of this file under either the
 * CDDL, the GPL Version 2 or to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL Version 2 license, then the
 * option applies only if the new code is made subject to such option by the copyright holder.
 */
package de.unentscheidbar.validation.builtin;

import java.io.File;
import java.io.IOException;

import org.apache.commons.lang3.StringUtils;

import de.unentscheidbar.validation.ValidationMessage;
import de.unentscheidbar.validation.ValidationResult;
import de.unentscheidbar.validation.swing.Validation;

/**
 * 
 * @author Tim Boudreau
 */
public final class FileNameValidator extends EmptyStringAcceptingValidator {

    /*
     * Technically NTFS and other file systems don't really care what characters are in a file name,
     * but operating system APIs often won't allow these because of their special meaning.
     */
    private static final char[] ILLEGAL_CHARACTERS = { '/', '\n', '\r', '\t', '\0', '\f', '`', '?', '*', '\\', '<',
            '>', '|', '\"', ':', File.separatorChar };

    public static enum Id implements ValidationMessage.Id {
        INVALID_FILE_NAME
    }

    private static final FileNameValidator INSTANCE = new FileNameValidator();

    public static FileNameValidator instance() {

        return INSTANCE;
    }

    private static final long serialVersionUID = Validation.VERSION;

    private FileNameValidator() {

        super();
    }

    @Override
    protected void validateNonEmptyString(ValidationResult problems, String text) {

        boolean invalid = StringUtils.containsAny(text, ILLEGAL_CHARACTERS);
        if (!invalid)
            try {
                /* Catch stuff like "PRN" on windows */
                new File(text).getCanonicalPath();
            } catch (IOException ignored) {
                invalid = true;
            }
        if (invalid) {
            problems.add(Id.INVALID_FILE_NAME, text);
        }
    }
}