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 filename into a {@link org.apache.commons.vfs2.FileName}. 024 */ 025public interface FileNameParser { 026 /** 027 * Check if a character needs encoding (%nn). 028 * 029 * @param ch the character 030 * @return true if character should be encoded 031 */ 032 boolean encodeCharacter(char ch); 033 034 /** 035 * parses a String into a filename. 036 * 037 * @param context The component context. 038 * @param base The base FileName. 039 * @param uri The target file name. 040 * @return A FileName that represents the taret file. 041 * @throws FileSystemException if an error occurs parsing the URI. 042 */ 043 FileName parseUri(final VfsComponentContext context, final FileName base, final String uri) 044 throws FileSystemException; 045}