@atomist/rug/model/PomMutableViewMutatingFunctions.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";

export { PomMutableViewMutatingFunctions };

/**
 * PomMutableViewMutatingFunctions
 */
interface PomMutableViewMutatingFunctions {

    /**
     * Adds or replaces a build plugin
     *
     * @param groupId {string} The value of the build plugin's groupId
     * @param artifactId {string} The value of the build plugin's artifactId
     * @param pluginContent {string} The XML content for the plugin
     */
    addOrReplaceBuildPlugin(groupId: string, artifactId: string, pluginContent: string): void;

    /**
     * Adds or replaces a build plugin management plugin
     *
     * @param groupId {string} The value of the build plugin management plugins's groupId
     * @param artifactId {string} The value of the build plugin management plugins's artifactId
     * @param pluginContent {string} The XML content for the plugin
     */
    addOrReplaceBuildPluginManagementPlugin(groupId: string, artifactId: string, pluginContent: string): void;

    /**
     * Add or replace a dependency
     *
     * @param groupId {string} The value of the dependency's groupId
     * @param artifactId {string} The value of the dependency's artifactId
     */
    addOrReplaceDependency(groupId: string, artifactId: string): void;

    /**
     * Adds or replaces a dependency management dependency
     *
     * @param groupId {string} The value of the dependency's groupId
     * @param artifactId {string} The value of the dependency's artifactId
     * @param dependencyContent {string} The XML content for the dependency
     */
    addOrReplaceDependencyManagementDependency(groupId: string, artifactId: string, dependencyContent: string): void;

    /**
     * Add or replace a dependency
     *
     * @param groupId {string} The value of the dependency's groupId
     * @param artifactId {string} The value of the dependency's artifactId
     * @param scope {string} The value of the dependency's scope
     */
    addOrReplaceDependencyOfScope(groupId: string, artifactId: string, scope: string): void;

    /**
     * Add or replace a dependency, providing version and scope
     *
     * @param groupId {string} The value of the dependency's groupId
     * @param artifactId {string} The value of the dependency's artifactId
     * @param newVersion {string} The value of the dependency's version to be set
     */
    addOrReplaceDependencyOfVersion(groupId: string, artifactId: string, newVersion: string): void;

    /**
     * Add or replace a dependency, providing version and scope
     *
     * @param groupId {string} The value of the dependency's groupId
     * @param artifactId {string} The value of the dependency's artifactId
     * @param newVersion {string} The value of the dependency's version to be set
     * @param scope {string} The value of the dependency's scope to be set
     */
    addOrReplaceDependencyOfVersionAndScope(groupId: string, artifactId: string, newVersion: string, scope: string): void;

    /**
     * Add or replace a dependency's scope
     *
     * @param groupId {string} The value of the dependency's groupId
     * @param artifactId {string} The value of the dependency's artifactId
     * @param newScope {string} The new value of the dependency's scope to be set
     */
    addOrReplaceDependencyScope(groupId: string, artifactId: string, newScope: string): void;

    /**
     * Add or replace a dependency's version
     *
     * @param groupId {string} The value of dependency's groupId
     * @param artifactId {string} The value of the dependency's artifactId
     * @param newVersion {string} The value of the dependency's version to be set
     */
    addOrReplaceDependencyVersion(groupId: string, artifactId: string, newVersion: string): void;

    /**
     * Adds or replaces a profile
     *
     * @param id {string} The value of the profile's id
     * @param profileContent {string} The XML content for the profile
     */
    addOrReplaceProfile(id: string, profileContent: string): void;

    /**
     * Add or replace a property
     *
     * @param propertyName {string} The name of the property being set
     * @param propertyValue {string} The value of the property being set
     */
    addOrReplaceProperty(propertyName: string, propertyValue: string): void;

    /**
     * Removes a dependency
     *
     * @param groupId {string} The value of the dependency's groupId
     * @param artifactId {string} The value of the dependency's artifactId
     */
    removeDependency(groupId: string, artifactId: string): void;

    /**
     * Remove a dependency's scope
     *
     * @param groupId {string} The value of the dependency's groupId
     * @param artifactId {string} The value of the dependency's artifactId
     */
    removeDependencyScope(groupId: string, artifactId: string): void;

    /**
     * Remove a dependency's version
     *
     * @param groupId {string} The value of the dependency's groupId
     * @param artifactId {string} The value of the dependency's artifactId
     */
    removeDependencyVersion(groupId: string, artifactId: string): void;

    /**
     * Remove a property
     *
     * @param propertyName {string} The name of the project property being deleted
     */
    removeProperty(propertyName: string): void;

    /**
     * Set the content of the parent block
     *
     * @param newParentBlock {string} The parent block that you are trying to set
     */
    replaceParent(newParentBlock: string): void;

    /**
     * Set the content of the artifactId element
     *
     * @param newArtifactId {string} The artifactId that you are trying to set
     */
    setArtifactId(newArtifactId: string): void;

    /**
     * Set the content of the description element
     *
     * @param newDescription {string} The description that you are trying to set
     */
    setDescription(newDescription: string): void;

    /**
     * Set the content of the groupId element
     *
     * @param newGroupId {string} The groupId that you are trying to set
     */
    setGroupId(newGroupId: string): void;

    /**
     * Set the content of the packaging element
     *
     * @param newPackaging {string} The packaging that you are trying to set
     */
    setPackaging(newPackaging: string): void;

    /**
     * Set the content of the parent artifactId element
     *
     * @param newParentArtifactId {string} The parent artifactId that you are trying to set
     */
    setParentArtifactId(newParentArtifactId: string): void;

    /**
     * Set the content of the parent groupId element
     *
     * @param newParentGroupId {string} The parent groupId that you are trying to set
     */
    setParentGroupId(newParentGroupId: string): void;

    /**
     * Set the content of the parent version element
     *
     * @param newParentVersion {string} The parent version that you are trying to set
     */
    setParentVersion(newParentVersion: string): void;

    /**
     * Add or replace project name
     *
     * @param newName {string} The name being set
     */
    setProjectName(newName: string): void;

    /**
     * Set the content of the version element
     *
     * @param newVersion {string} The version that you are trying to set
     */
    setVersion(newVersion: string): void;

}