org.codehaus.mojo.tidy.task.TidyTask Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tidy-maven-plugin Show documentation

Tidy Plugin for Maven. The Tidy plugin provides goals for tidying up your source code.

There is a newer version: 1.3.0

package org.codehaus.mojo.tidy.task;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 javax.xml.stream.XMLStreamException;

/**
 * A single task that tidies a POM.
 */
interface TidyTask
{
    /**
     * Tidies the POM.
     *
     * @param pom    the POM as string.
     * @param format the expected format of the POM.
     * @return the tidy POM.
     * @throws XMLStreamException
     */
    String tidyPom( String pom, Format format )
        throws XMLStreamException;
}