001/*
002 * JDrupes Builder
003 * Copyright (C) 2025 Michael N. Lipp
004 * 
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Affero General Public License as
007 * published by the Free Software Foundation, either version 3 of the
008 * License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
013 * GNU Affero General Public License for more details.
014 *
015 * You should have received a copy of the GNU Affero General Public License
016 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
017 */
018
019package org.jdrupes.builder.eclipse;
020
021import org.jdrupes.builder.api.Project;
022import org.jdrupes.builder.api.Resource;
023import org.jdrupes.builder.api.ResourceFactory;
024import org.jdrupes.builder.api.ResourceType;
025
026/// A resource request for the Eclipse configuration files. The request
027/// results in information about the Eclipse configuration.
028///
029public interface EclipseConfiguration extends Resource {
030
031    /// The jdbld project name.
032    ///
033    /// @return the string
034    ///
035    String projectName();
036
037    /// The project name used in the Eclipse configuration.
038    ///
039    /// @return the string
040    ///
041    String eclipseAlias();
042
043    /// Creates a new EclipseConfiguration from the given values.
044    ///
045    /// @param project the project
046    /// @param eclipseAlias the eclipse alias
047    /// @return the eclipse configuration
048    ///
049    @SuppressWarnings("PMD.ShortMethodName")
050    static EclipseConfiguration of(Project project, String eclipseAlias) {
051        return ResourceFactory.create(new ResourceType<>() {},
052            project, project.name(), eclipseAlias);
053    }
054}