com.intellij.openapi.vfs.VirtualFileWrapper.java Source code

Introduction

Here is the source code for com.intellij.openapi.vfs.VirtualFileWrapper.java

Source

/*
 * Copyright 2000-2009 JetBrains s.r.o.
 *
 * Licensed 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 com.intellij.openapi.vfs;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

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

/**
 * Utility class for work with both java.io.File and VirtualFile. It helps
 * to create new VirtualFiles by java.io.Files. It is helpful for storing
 * information about non-existing files with possibility to create VirtualFile
 * on demand.
 *
 * @author Konstantin Bulenkov
 * @see com.intellij.openapi.vfs.VirtualFile
 */
public class VirtualFileWrapper {
    private final File myFile;

    /**
     * Constructs wrapper based on java.io.File
     *
     * @param file java.io.File
     */
    public VirtualFileWrapper(@NotNull File file) {
        myFile = file;
    }

    /**
     * Tests whether the file passed to constructor exists.
     *
     * @return  {@code true} if and only if the file passed to constructor
     * exists; {@code false} otherwise
     *
     * @throws SecurityException
     *          If a security manager exists and its <code>{@link
     *          java.lang.SecurityManager#checkRead(java.lang.String)}</code>
     *          method denies read access to the file or directory
     */
    public boolean exists() {
        return myFile.exists();
    }

    /**
     * Refreshes LocalFileSystem and looks for VirtualFile
     *
     * @return VirtualFile or null if file is not exist
     */
    @Nullable
    public VirtualFile getVirtualFile() {
        return LocalFileSystem.getInstance().refreshAndFindFileByIoFile(myFile);
    }

    /**
     * Looks for VirtualFile and tries to create new VirtualFile if
     * <tt>createIfNotExist</tt> is <tt>true</tt> and file is not exist.
     *
     * @param createIfNotExist if <tt>true</tt> and java.io.File is not exist,
     *      VirtualFileWrapper will try to create new file
     *
     * @return virtual file
     */
    @Nullable
    public VirtualFile getVirtualFile(boolean createIfNotExist) {
        if (createIfNotExist && !myFile.exists()) {
            try {
                if (!myFile.createNewFile()) {
                    return null;
                }
            } catch (IOException e) {//
            }
        }
        return getVirtualFile();
    }

    /**
     * Returns original java.io.File
     *
     * @return original java.io.File
     */
    @NotNull
    public File getFile() {
        return myFile;
    }
}