@atomist/rug/model/Directory.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 { ArtifactContainer } from "./ArtifactContainer";
import { ArtifactContainerView } from "./ArtifactContainerView";
import { MutableView } from "./MutableView";
export { Directory };

/**
 * Type for a directory within a project.
 */
interface Directory extends ArtifactContainer, ArtifactContainerView, MutableView {

    /**
     * Return the number of files directly in this directory
     *
     * @returns {number}
     */
    fileCount(): number;

    /**
     * Return the name of the directory
     *
     * @returns {string}
     */
    name(): string;

    /**
     * Return the path of the directory
     *
     * @returns {string}
     */
    path(): string;

}