SourceFile.java

/**
 * Copyright 2013 
 * 
 * HAN University of Applied Sciences
 * Maik Diepenbroek
 * Wouter Konecny
 * Sjoerd van den Top
 * Teun van Vegchel
 * Niek Versteege
 *
 * See the file MIT-license.txt for copying permission.
 */


/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */
package nl.han.ica.core;

import nl.han.ica.core.util.FileUtil;
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jface.text.Document;
import org.eclipse.jface.text.IDocument;

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

/**
 * Wraps around a {@link File} and its {@link CompilationUnit}.
 */
public class SourceFile {

    public static final String SOURCE_FILE_PROPERTY = "nl.han.ica.core.source_file.source_file_property";

    private File file;
    private CompilationUnit compilationUnit;

    /**
     * Instantiate a new SourceFile for a certain {@link File}.
     *
     * @param file The actual file.
     */
    public SourceFile(File file) {
        this.file = file;
    }

    /**
     * Gets the {@link File} this SourceFile wraps around.
     *
     * @return the File this SourceFile wraps around.
     */
    public File getFile() {
        return file;
    }

    /**
     * Set the SourceFile's File.
     *
     * @param file The File this SourceFile wraps around.
     */
    public void setFile(File file) {
        this.file = file;
    }

    /**
     * Set the CompilationUnit that belongs to the content of the SourceFile's file.
     *
     * @param compilationUnit The compilation unit.
     */
    public void setCompilationUnit(CompilationUnit compilationUnit) {
        this.compilationUnit = compilationUnit;
        this.compilationUnit.setProperty(SOURCE_FILE_PROPERTY, this);
    }

    /**
     * Get the compilation unit that belongs to the content of the source file's file.
     *
     * @return The source file's compilation unit
     */
    public CompilationUnit getCompilationUnit() {
        return compilationUnit;
    }

    /**
     * Create a document based on this source file's file.
     *
     * @return Document based on the source file's file.
     * @throws IOException Thrown when the file's contents could not be read.
     */
    public IDocument toDocument() throws IOException {
        return new Document(FileUtil.getFileContent(file));
    }

}