@atomist/rug/model/JavaSource.ts

TypeScript model for Atomist Rugs, see http://docs.atomist.com/

/*
 * Copyright 2015-2017 Atomist Inc.
 *
 * 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.
 */

import { TreeNode, GraphNode, FormatInfo, PathExpressionEngine } from "@atomist/rug/tree/PathExpression";
import { ProjectContext } from "@atomist/rug/operations/ProjectEditor";
import { FileArtifactBacked } from "./FileArtifactBacked";
import { MutableView } from "./MutableView";
import { JavaProject } from "./JavaProject";
export { JavaSource };

/**
 * Java source file
 */
interface JavaSource extends FileArtifactBacked, MutableView {

    /**
     * Return the Java project
     *
     * @returns {JavaProject}
     */
    javaProject(): JavaProject;

    /**
     * Move the source file to the given package
     *
     * @param newPackage {string} The package to move the source file to
     */
    movePackage(newPackage: string): void;

    /**
     * Return the package name
     *
     * @returns {string}
     */
    pkg(): string;

    /**
     * Count the types in this source file
     *
     * @returns {number}
     */
    typeCount(): number;

}