org.apache.maven.model.building.FileModelSource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-model-builder Show documentation
The newest version!
/*
 * 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.
 */
package org.apache.maven.model.building;

import java.io.File;
import java.net.URI;
import java.nio.file.Path;

import org.apache.maven.building.FileSource;
import org.apache.maven.model.locator.ModelLocator;

/**
 * Wraps an ordinary {@link File} as a model source.
 *
 * @deprecated use {@link org.apache.maven.api.services.ModelBuilder} instead
 */
@Deprecated(since = "4.0.0")
public class FileModelSource extends FileSource implements ModelSource3 {

    /**
     * Creates a new model source backed by the specified file.
     *
     * @param pomFile The POM file, must not be {@code null}.
     * @deprecated Use {@link #FileModelSource(Path)} instead.
     */
    @Deprecated
    public FileModelSource(File pomFile) {
        super(pomFile);
    }

    /**
     * Creates a new model source backed by the specified file.
     *
     * @param pomPath The POM file, must not be {@code null}.
     * @since 4.0.0
     */
    public FileModelSource(Path pomPath) {
        super(pomPath);
    }

    /**
     *
     * @return the file of this source
     *
     * @deprecated instead use {@link #getFile()}
     */
    @Deprecated
    public File getPomFile() {
        return getFile();
    }

    @Override
    public ModelSource3 getRelatedSource(ModelLocator locator, String relPath) {
        relPath = relPath.replace('\\', File.separatorChar).replace('/', File.separatorChar);

        Path path = getPath().getParent().resolve(relPath);

        Path relatedPom = locator.locateExistingPom(path);

        if (relatedPom != null) {
            return new FileModelSource(relatedPom.normalize());
        }

        return null;
    }

    @Override
    public URI getLocationURI() {
        return getPath().toUri();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }

        if (obj == null) {
            return false;
        }

        if (!FileModelSource.class.equals(obj.getClass())) {
            return false;
        }
        FileModelSource other = (FileModelSource) obj;
        return getPath().equals(other.getPath());
    }

    @Override
    public int hashCode() {
        return getPath().hashCode();
    }
}