All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.gradle.tooling.model.eclipse.EclipseProject Maven / Gradle / Ivy

The newest version!
/*
 * Copyright 2011 the original author or authors.
 *
 * 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.
 */
package org.gradle.tooling.model.eclipse;

import org.gradle.tooling.model.DomainObjectSet;
import org.gradle.tooling.model.GradleProject;
import org.gradle.tooling.model.HasGradleProject;
import org.gradle.tooling.model.UnsupportedMethodException;

import javax.annotation.Nullable;

/**
 * The complete model of an Eclipse project.
 *
 * 

Note that the names of Eclipse projects are unique, and can be used as an identifier for the project. * * @since 1.0-milestone-3 */ public interface EclipseProject extends HierarchicalEclipseProject { /** * {@inheritDoc} */ @Override EclipseProject getParent(); /** * {@inheritDoc} */ @Override DomainObjectSet getChildren(); /** * Returns the Java source settings for this project. * * @return the settings for Java sources or {@code null} if not a Java element. * @throws UnsupportedMethodException For Gradle versions older than 2.10, where this method is not supported. * @since 2.10 */ @Nullable EclipseJavaSourceSettings getJavaSourceSettings() throws UnsupportedMethodException; /** * The gradle project that is associated with this project. * Typically, a single Eclipse project corresponds to a single gradle project. *

* See {@link HasGradleProject} * * @return associated gradle project * @since 1.0-milestone-5 */ @Override GradleProject getGradleProject(); /** * Returns the external dependencies which make up the classpath of this project. * * @return The dependencies. Returns an empty set if the project has no external dependencies. * @since 1.0-milestone-3 */ DomainObjectSet getClasspath(); /** * Returns the Eclipse natures configured on the project. *

* Some natures are automatically added to the result based on the Gradle plugins applied on the project. * For example, if the project applies the 'java' plugin the result will contain the * {@code "org.eclipse.jdt.core.javanature"} entry. Note, that the exact list of automatically added * natures is not part of the API and can vary between Gradle releases. *

* The result can be customized via the 'eclipse' plugin configuration. * * @return The list of Eclipse project natures. * @since 2.9 * @throws UnsupportedMethodException For Gradle versions older than 2.9, where this method is not supported. */ DomainObjectSet getProjectNatures() throws UnsupportedMethodException; /** * Returns the Eclipse build commands configured on the project. *

* Some build commands are automatically added to the result based on the Gradle plugins applied on the project. * For example, if the project applies the 'java' plugin the result will contain the * {@code "org.eclipse.jdt.core.javabuilder"} build command. Note, that the exact list of automatically * added build commands is not part of the API and can vary between Gradle releases. *

* The result can be customized via the 'eclipse' plugin configuration. * * @return The list of Eclipse build commands. * @since 2.9 * @throws UnsupportedMethodException For Gradle versions older than 2.9, where this method is not supported. */ DomainObjectSet getBuildCommands() throws UnsupportedMethodException; /** * Returns the Eclipse classpath containers defined on the project. * * @return The list of classpath containers. * @since 3.0 * @throws UnsupportedMethodException For Gradle versions older than 3.0, where this method is not supported. */ DomainObjectSet getClasspathContainers() throws UnsupportedMethodException; /** * Returns the output location of this project. * * @return The project's output location. * @since 3.0 * @throws UnsupportedMethodException For Gradle versions older than 3.0, where this method is not supported. */ EclipseOutputLocation getOutputLocation() throws UnsupportedMethodException; /** * If this method returns true then Eclipse should execute the tasks configured at {@code eclipse.autoBuildTasks} * every time the auto-build is triggered for the target project. * * @return whether the project has auto-build tasks configured * @since 5.4 * @see RunEclipseAutoBuildTasks */ boolean hasAutoBuildTasks(); }





© 2015 - 2025 Weber Informatics LLC | Privacy Policy