001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.vfs2.provider;
018
019import org.apache.commons.vfs2.FileName;
020import org.apache.commons.vfs2.FileSystemException;
021
022/**
023 * Provides methods to parse a file name into a {@link org.apache.commons.vfs2.FileName}.
024 */
025public interface FileNameParser {
026
027    /**
028     * Check if a character needs encoding (%nn).
029     *
030     * @param ch the character
031     * @return true if character should be encoded
032     */
033    boolean encodeCharacter(char ch);
034
035    /**
036     * Parses a String into a file name.
037     *
038     * @param context The component context.
039     * @param base The base FileName.
040     * @param uri The target file name.
041     * @return A FileName that represents the taret file.
042     * @throws FileSystemException if an error occurs parsing the URI.
043     */
044    FileName parseUri(VfsComponentContext context, FileName base, String uri) throws FileSystemException;
045}