commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/local/LocalFileName.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.commons.vfs2.provider.local;

import java.net.URI;
import java.nio.file.Path;
import java.nio.file.Paths;

import org.apache.commons.vfs2.FileName;
import org.apache.commons.vfs2.FileSystemException;
import org.apache.commons.vfs2.FileType;
import org.apache.commons.vfs2.provider.AbstractFileName;
import org.apache.commons.vfs2.provider.UriParser;

/**
 * A local file URI.
 */
public class LocalFileName extends AbstractFileName {

    private final String rootFile;

    protected LocalFileName(final String scheme, final String rootFile, final String path, final FileType type) {
        super(scheme, path, type);
        this.rootFile = rootFile;
    }

    /**
     * Builds the root URI for this file name.
     */
    @Override
    protected void appendRootUri(final StringBuilder buffer, final boolean addPassword) {
        buffer.append(getScheme());
        buffer.append("://");
        buffer.append(rootFile);
    }

    /**
     * Factory method for creating name instances.
     *
     * @param path The file path.
     * @param type The file type.
     * @return The FileName.
     */
    @Override
    public FileName createName(final String path, final FileType type) {
        return new LocalFileName(getScheme(), rootFile, path, type);
    }

    @Override
    protected String createURI() {
        final StringBuilder buffer = new StringBuilder();
        appendRootUri(buffer, true);
        final URI tmpUri = getFilePath().toUri();
        buffer.append(tmpUri.getRawPath());
        final String query = tmpUri.getRawQuery();
        if (query != null) {
            buffer.append('?');
            buffer.append(query);
        }
        final String fragment = tmpUri.getRawFragment();
        if (fragment != null) {
            buffer.append('#');
            buffer.append(fragment);
        }
        return buffer.toString();
    }

    private String createUriDecoded() throws FileSystemException {
        return UriParser.decode(getURI());
    }

    /**
     * Gets the NIO file Path.
     *
     * @return the NIO file Path.
     */
    private Path getFilePath() {
        return Paths.get(getPath());
    }

    /**
     * Returns the root file for this file.
     *
     * @return The root file name.
     */
    public String getRootFile() {
        return rootFile;
    }

    /**
     * Returns the decoded URI of the file.
     *
     * @return the FileName as a URI.
     */
    @Override
    public String toString() {
        try {
            return createUriDecoded();
        } catch (final FileSystemException e) {
            return getURI();
        }
    }
}